Skip to content

Commit d075807

Browse files
Added createStreamAs comments to aid in helpful intellisense
1 parent a0d3747 commit d075807

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

ksqljs/ksqlJS.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,13 @@ class ksqljs {
171171

172172
/**
173173
*
174-
* @param {string} streamName
175-
* @param {string[]} selectColumns
176-
* @param {string} sourceStream
177-
* @param {object} propertiesObj
178-
* @param {string} conditions
179-
* @param {string} partitionBy
180-
* @returns {Promise}
174+
* @param {string} streamName - the name of the stream to be created
175+
* @param {string[]} selectColumns - the columns from the underlying stream to be included in the new materialized stream
176+
* @param {string} sourceStream - the underlying stream from which the new materialized stream will be created
177+
* @param {object} propertiesObj - an object whose keys are property names and values are the associated values
178+
* @param {string} conditions - a string containing the conditional statement (i.e., the 'WHERE' statement)
179+
* @param {string} partitionBy - column by which data will be distributed
180+
* @returns {Promise} - a promise that completes once the server response is received, and returns a query ID
181181
*/
182182
createStreamAs = (streamName, selectColumns, sourceStream, propertiesObj, conditions, partitionBy) => {
183183
const propertiesArgs = [];

0 commit comments

Comments
 (0)