Skip to content

Commit 5efb48a

Browse files
committed
Add note
1 parent 703e97a commit 5efb48a

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

lib/node_modules/@stdlib/array/to-iterator/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ var count = ctx.count;
154154
- If an environment supports `Symbol.iterator`, the returned iterator is iterable.
155155
- If provided a generic `array`, the returned iterator does **not** ignore holes. To achieve greater performance for sparse arrays, use a custom iterator.
156156
- A returned iterator does **not** copy a provided array-like `object`. To ensure iterable reproducibility, copy a provided array-like `object` **before** creating an iterator. Otherwise, any changes to the contents of an array-like `object` will be reflected in the returned iterator.
157+
- In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an array's `@@iterator` method, regardless of whether this method is defined. To convert an array to an implementation defined iterator, invoke this method directly.
157158

158159
</section>
159160

lib/node_modules/@stdlib/array/to-iterator/docs/repl.txt

+5
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
If an environment supports Symbol.iterator, the returned iterator is
1212
iterable.
1313

14+
If an environment supports Symbol.iterator, the function explicitly does not
15+
not invoke an array's `@@iterator` method, regardless of whether this method
16+
is defined. To convert an array to an implementation defined iterator,
17+
invoke this method directly.
18+
1419
Parameters
1520
----------
1621
src: ArrayLike

0 commit comments

Comments
 (0)