You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/iter/map/README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ limitations under the License.
20
20
21
21
# iterMap
22
22
23
-
> Create an iterator which invokes a function for each iterated value.
23
+
> Create an [iterator][mdn-iterator-protocol] which invokes a function for each iterated value.
24
24
25
25
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26
26
@@ -42,7 +42,7 @@ var iterMap = require( '@stdlib/iter/map' );
42
42
43
43
#### iterMap( iterator, fcn\[, thisArg] )
44
44
45
-
Returns an iterator which invokes a `function` for each iterated value.
45
+
Returns an [iterator][mdn-iterator-protocol] which invokes a `function` for each iterated value.
46
46
47
47
```javascript
48
48
var array2iterator =require( '@stdlib/array/to-iterator' );
@@ -66,10 +66,10 @@ r = it.next().value;
66
66
// ...
67
67
```
68
68
69
-
The returned iterator protocol-compliant object has the following properties:
69
+
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
70
70
71
-
-**next**: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
72
-
-**return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
71
+
-**next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
72
+
-**return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
73
73
74
74
The invoked `function` is provided two arguments:
75
75
@@ -138,7 +138,7 @@ var count = ctx.count;
138
138
139
139
## Notes
140
140
141
-
- If an environment supports `Symbol.iterator`**and** a provided iterator is iterable, the returned iterator is iterable.
141
+
- If an environment supports `Symbol.iterator`**and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
0 commit comments