File tree 1 file changed +11
-10
lines changed
lib/node_modules/@stdlib/iter/flow/lib
1 file changed +11
-10
lines changed Original file line number Diff line number Diff line change @@ -36,6 +36,17 @@ var iteratorSymbol = require( '@stdlib/symbol/iterator' );
36
36
/**
37
37
* Returns a constructor for creating a fluent interface for chaining together iterator methods.
38
38
*
39
+ * ## Notes
40
+ *
41
+ * - We assume that each provided iterator function has the following function signature:
42
+ *
43
+ * ```text
44
+ * function iterFcn( iterator[, ...args] ) {...}
45
+ * ```
46
+ *
47
+ * where `iterator` is an input iterator and `args` are additional iterator function arguments (if any).
48
+ *
49
+ *
39
50
* @param {Object } methods - an object mapping method names to iterator functions
40
51
* @throws {TypeError } must provide an object
41
52
* @throws {TypeError } object property values must be functions
@@ -162,16 +173,6 @@ function iterFlow( methods ) {
162
173
/**
163
174
* Wraps an iterator function as a fluent interface method.
164
175
*
165
- * ## Notes
166
- *
167
- * - We assume that the provided iterator function has the following function signature:
168
- *
169
- * ```text
170
- * function iterFcn( iterator[, ...args] ) {...}
171
- * ```
172
- *
173
- * where `iterator` is an input iterator and `args` are additional iterator function arguments (if any).
174
- *
175
176
* @private
176
177
* @param {Function } iterFcn - iterator function
177
178
* @returns {Function } method wrapper
You can’t perform that action at this time.
0 commit comments