Skip to content

Commit c658542

Browse files
feat(iter/cartesian-square): add docs/repl.txt
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent ad86867 commit c658542

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/iter/cartesian-square/docs
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
{{alias}}( iterator )
3+
Returns an iterator of the Cartesian square.
4+
5+
If an environment supports Symbol.iterator and a provided iterator is
6+
iterable, the returned iterator is iterable.
7+
8+
Parameters
9+
----------
10+
iterator: Collection
11+
Input collection.
12+
13+
Returns
14+
-------
15+
iterator: Object
16+
Iterator.
17+
18+
iterator.next(): Function
19+
Returns an iterator protocol-compliant object containing the next
20+
iterated value (if one exists) and a boolean flag indicating whether the
21+
iterator is finished.
22+
23+
iterator.return( [value] ): Function
24+
Finishes an iterator and returns a provided value.
25+
26+
Examples
27+
--------
28+
> var it = {{alias}}( [ 1, 2 ] );
29+
> var v = it.next().value
30+
[ 1, 1 ]
31+
> v = it.next().value
32+
[ 1, 2 ]
33+
34+
See Also
35+
--------
36+

0 commit comments

Comments
 (0)