Skip to content

Commit

Permalink
docs: update namespace table of contents
Browse files Browse the repository at this point in the history 
PR-URL: #1920

Signed-off-by: stdlib-bot <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
@stdlib-bot @Planeshifter
stdlib-bot and Planeshifter authored Mar 16, 2024
1 parent f134dac commit 5c03720
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/array/base/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ The namespace exports the following:
- <span class="signature">[`copyIndexed( x )`][@stdlib/array/base/copy-indexed]</span><span class="delimiter">: </span><span class="description">copy the elements of an indexed array-like object to a new "generic" array.</span>
- <span class="signature">[`copy( x )`][@stdlib/array/base/copy]</span><span class="delimiter">: </span><span class="description">copy the elements of an array-like object to a new "generic" array.</span>
- <span class="signature">[`countFalsy( x )`][@stdlib/array/base/count-falsy]</span><span class="delimiter">: </span><span class="description">count the number of falsy elements in an array.</span>
- <span class="signature">[`countSameValueZero( x, value )`][@stdlib/array/base/count-same-value-zero]</span><span class="delimiter">: </span><span class="description">count the number of elements in an array that are equal to a specified value.</span>
- <span class="signature">[`countSameValue( x, value )`][@stdlib/array/base/count-same-value]</span><span class="delimiter">: </span><span class="description">count the number of elements in an array that are equal to a specified value.</span>
- <span class="signature">[`countTruthy( x )`][@stdlib/array/base/count-truthy]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements in an array.</span>
- <span class="signature">[`dedupe( x, limit, equalNaNs )`][@stdlib/array/base/dedupe]</span><span class="delimiter">: </span><span class="description">remove consecutive duplicated values.</span>
- <span class="signature">[`everyByRight( x, predicate[, thisArg] )`][@stdlib/array/base/every-by-right]</span><span class="delimiter">: </span><span class="description">test whether all elements in an array pass a test implemented by a predicate function, iterating from right to left.</span>
Expand Down Expand Up @@ -337,6 +339,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/array/base/dedupe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/dedupe
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,7 @@ The remaining namespace utilities are as follows:
- <span class="signature">[`isNonConfigurableProperty( value, property )`][@stdlib/assert/is-nonconfigurable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is non-configurable.</span>
- <span class="signature">[`isNonEnumerablePropertyIn( value, property )`][@stdlib/assert/is-nonenumerable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is non-enumerable.</span>
- <span class="signature">[`isNonEnumerableProperty( value, property )`][@stdlib/assert/is-nonenumerable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is non-enumerable.</span>
- <span class="signature">[`isNonNegativeFinite( value )`][@stdlib/assert/is-nonnegative-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonnegative finite value.</span>
- <span class="signature">[`isObjectLike( value )`][@stdlib/assert/is-object-like]</span><span class="delimiter">: </span><span class="description">test if a value is object-like.</span>
- <span class="signature">[`isOdd( value )`][@stdlib/assert/is-odd]</span><span class="delimiter">: </span><span class="description">test if a value is an odd number.</span>
- <span class="signature">[`isPascalcase( value )`][@stdlib/assert/is-pascalcase]</span><span class="delimiter">: </span><span class="description">test if a value is a string in Pascal case.</span>
Expand Down Expand Up @@ -686,6 +687,8 @@ console.log( objectKeys( assert ) );

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

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

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

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

1 comment on commit 5c03720

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base $\color{green}1518/1518$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}1518/1518$
$\color{green}+100.00\%$
assert $\color{green}2679/2679$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}2679/2679$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.