Skip to content

Commit c9ee72c

Browse files
committed
Add links
1 parent 6d3b939 commit c9ee72c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

lib/node_modules/@stdlib/iter/map/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# iterMap
2222

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.
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -42,7 +42,7 @@ var iterMap = require( '@stdlib/iter/map' );
4242

4343
#### iterMap( iterator, fcn\[, thisArg] )
4444

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.
4646

4747
```javascript
4848
var array2iterator = require( '@stdlib/array/to-iterator' );
@@ -66,10 +66,10 @@ r = it.next().value;
6666
// ...
6767
```
6868

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:
7070

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.
7373

7474
The invoked `function` is provided two arguments:
7575

@@ -138,7 +138,7 @@ var count = ctx.count;
138138

139139
## Notes
140140

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.
142142

143143
</section>
144144

@@ -199,6 +199,8 @@ while ( true ) {
199199

200200
<section class="links">
201201

202+
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
203+
202204
</section>
203205

204206
<!-- /.links -->

0 commit comments

Comments
 (0)