Skip to content

docs: update namespace table of contents #7062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged

docs: update namespace table of contents #7062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ The namespace exports the following:
- <span class="signature">[`accessors( x )`][@stdlib/array/base/accessors]</span><span class="delimiter">: </span><span class="description">return element accessors for a provided array-like object.</span>
- <span class="signature">[`anyByRight( x, predicate[, thisArg] )`][@stdlib/array/base/any-by-right]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an array passes a test implemented by a predicate function, while iterating from right to left.</span>
- <span class="signature">[`anyBy( x, predicate[, thisArg] )`][@stdlib/array/base/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an array passes a test implemented by a predicate function.</span>
- <span class="signature">[`anyHasOwnProp( arr, property )`][@stdlib/array/base/any-has-own-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property.</span>
- <span class="signature">[`anyHasProp( arr, property )`][@stdlib/array/base/any-has-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property, either own or inherited.</span>
- <span class="signature">[`anyIsEntryIn( arr, property, value )`][@stdlib/array/base/any-is-entry-in]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property key-value pair, either own or inherited.</span>
- <span class="signature">[`anyIsEntry( arr, property, value )`][@stdlib/array/base/any-is-entry]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property key-value pair.</span>
- <span class="signature">[`any( x )`][@stdlib/array/base/any]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an array is truthy.</span>
- <span class="signature">[`arraylike2object( x )`][@stdlib/array/base/arraylike2object]</span><span class="delimiter">: </span><span class="description">convert an array-like object to an object likely to have the same "shape".</span>
- <span class="signature">[`assert`][@stdlib/array/base/assert]</span><span class="delimiter">: </span><span class="description">base array assertion utilities.</span>
Expand Down Expand Up @@ -324,6 +328,14 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );

[@stdlib/array/base/any-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any-by

[@stdlib/array/base/any-has-own-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any-has-own-property

[@stdlib/array/base/any-has-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any-has-property

[@stdlib/array/base/any-is-entry-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any-is-entry-in

[@stdlib/array/base/any-is-entry]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any-is-entry

[@stdlib/array/base/any]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/any

[@stdlib/array/base/arraylike2object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/arraylike2object
Expand Down
12 changes: 0 additions & 12 deletions lib/node_modules/@stdlib/array/base/assert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@ The namespace exports the following:

<div class="namespace-toc">

- <span class="signature">[`anyHasOwnProp( arr, property )`][@stdlib/array/base/assert/any-has-own-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property.</span>
- <span class="signature">[`anyHasProp( arr, property )`][@stdlib/array/base/assert/any-has-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property, either own or inherited.</span>
- <span class="signature">[`anyIsEntryIn( arr, property )`][@stdlib/array/base/assert/any-is-entry-in]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property key-value pair, either own or inherited.</span>
- <span class="signature">[`anyIsEntry( arr, property, value )`][@stdlib/array/base/assert/any-is-entry]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property key-value pair.</span>
- <span class="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array contains a provided search value.</span>
- <span class="signature">[`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]</span><span class="delimiter">: </span><span class="description">test if two indexed arrays have equal values.</span>
- <span class="signature">[`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have equal values.</span>
Expand Down Expand Up @@ -179,14 +175,6 @@ console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) );

<!-- <toc-links> -->

[@stdlib/array/base/assert/any-has-own-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/any-has-own-property

[@stdlib/array/base/assert/any-has-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/any-has-property

[@stdlib/array/base/assert/any-is-entry-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/any-is-entry-in

[@stdlib/array/base/assert/any-is-entry]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/any-is-entry

[@stdlib/array/base/assert/contains]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/contains

[@stdlib/array/base/assert/has-equal-values-indexed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/has-equal-values-indexed
Expand Down