Skip to content

Commit e28064f

Browse files
authored
docs: update namespace TypeScript declarations
PR-URL: #6478 Reviewed-by: Athan Reines <[email protected]>
1 parent f2c38e2 commit e28064f

File tree

1 file changed

+8
-0
lines changed
  • lib/node_modules/@stdlib/array/base/docs/types

1 file changed

+8
-0
lines changed

lib/node_modules/@stdlib/array/base/docs/types/index.d.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2856,9 +2856,13 @@ interface Namespace {
28562856
*
28572857
* ## Notes
28582858
*
2859+
* - The function uses the [SameValue Algorithm][ecma-262-same-value-algorithm], as specified in ECMAScript 5.
2860+
* - In contrast to the strict equality operator `===`, `-0` and `+0` are distinguishable and `NaNs` are the same.
28592861
* - If unable to find an element which equals a provided search element, the function returns `-1`.
28602862
* - If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`.
28612863
*
2864+
* [ecma-262-same-value-algorithm]: http://ecma-international.org/ecma-262/5.1/#sec-9.12
2865+
*
28622866
* @param x - input array
28632867
* @param searchElement - search element
28642868
* @param fromIndex - starting index (inclusive)
@@ -2979,10 +2983,14 @@ interface Namespace {
29792983
*
29802984
* ## Notes
29812985
*
2986+
* - The function uses the [SameValue Algorithm][ecma-262-same-value-algorithm], as specified in ECMAScript 5.
2987+
* - In contrast to the strict equality operator `===`, `-0` and `+0` are distinguishable and `NaNs` are the same.
29822988
* - The function scans an input array from the starting index to the beginning of the array (i.e., backward).
29832989
* - If unable to find an element which equals a provided search element, the function returns `-1`.
29842990
* - If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`.
29852991
*
2992+
* [ecma-262-same-value-algorithm]: http://ecma-international.org/ecma-262/5.1/#sec-9.12
2993+
*
29862994
* @param x - input array
29872995
* @param searchElement - search element
29882996
* @param fromIndex - starting index (inclusive)

0 commit comments

Comments
 (0)