Skip to content

docs: update namespace table of contents #9240

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
kgryte merged 1 commit into from
Dec 19, 2025
Merged

docs: update namespace table of contents #9240

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
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,11 @@ The namespace includes utilities for validating other special arrays or buffers:
- <span class="signature">[`isAlmostEqualComplex64array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-complex64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostEqualFloat32array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float32Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostEqualFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostSameValueArray( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostSameValueComplex128Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex128array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostSameValueComplex64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostSameValueFloat32Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isAlmostSameValueFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
- <span class="signature">[`isArrayLength( value )`][@stdlib/assert/is-array-length]</span><span class="delimiter">: </span><span class="description">test if a value is a valid array length.</span>
- <span class="signature">[`isArrayLikeObject( value )`][@stdlib/assert/is-array-like-object]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object.</span>
- <span class="signature">[`isArrayLike( value )`][@stdlib/assert/is-array-like]</span><span class="delimiter">: </span><span class="description">test if a value is array-like.</span>
Expand Down Expand Up @@ -974,6 +979,16 @@ console.log( objectKeys( assert ) );

[@stdlib/assert/is-almost-equal-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-equal-float64array

[@stdlib/assert/is-almost-same-value-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-array

[@stdlib/assert/is-almost-same-value-complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-complex128array

[@stdlib/assert/is-almost-same-value-complex64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-complex64array

[@stdlib/assert/is-almost-same-value-float32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-float32array

[@stdlib/assert/is-almost-same-value-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-almost-same-value-float64array

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

[@stdlib/assert/is-array-like-object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-array-like-object
Expand Down