Skip to content

Commit 39827ea

Browse files
Update namespace table of contents (#463)
Co-authored-by: Planeshifter <[email protected]>
1 parent 1df2836 commit 39827ea

File tree

24 files changed

+179
-51
lines changed

24 files changed

+179
-51
lines changed

Diff for: lib/node_modules/@stdlib/array/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ Lastly, the namespace contains various other functions for dealing with arrays,
154154
- <span class="signature">[`convertArray( arr, dtype )`][@stdlib/array/convert]</span><span class="delimiter">: </span><span class="description">convert an array to an array of a different data type.</span>
155155
- <span class="signature">[`DataView( buffer[, byteOffset[, byteLength]] )`][@stdlib/array/dataview]</span><span class="delimiter">: </span><span class="description">constructor which returns a data view representing a provided array buffer.</span>
156156
- <span class="signature">[`arrayDataType( array )`][@stdlib/array/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of an array.</span>
157+
- <span class="signature">[`filledarrayBy()`][@stdlib/array/filled-by]</span><span class="delimiter">: </span><span class="description">create a filled array according to a provided callback function.</span>
157158
- <span class="signature">[`filledarray()`][@stdlib/array/filled]</span><span class="delimiter">: </span><span class="description">create a filled array.</span>
158159
- <span class="signature">[`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span>
159160
- <span class="signature">[`arrayMinDataType( value )`][@stdlib/array/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value.</span>
@@ -227,6 +228,8 @@ console.log( objectKeys( ns ) );
227228

228229
[@stdlib/array/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dtype
229230

231+
[@stdlib/array/filled-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/filled-by
232+
230233
[@stdlib/array/filled]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/filled
231234

232235
[@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator

Diff for: lib/node_modules/@stdlib/assert/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,9 @@ The remaining namespace utilities are as follows:
354354
- <span class="signature">[`hasProp( value, property )`][@stdlib/assert/has-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property, either own or inherited.</span>
355355
- <span class="signature">[`hasUTF16SurrogatePairAt( string, position )`][@stdlib/assert/has-utf16-surrogate-pair-at]</span><span class="delimiter">: </span><span class="description">test if a position in a string marks the start of a UTF-16 surrogate pair.</span>
356356
- <span class="signature">[`instanceOf( value, constructor )`][@stdlib/assert/instance-of]</span><span class="delimiter">: </span><span class="description">test whether a value has in its prototype chain a specified constructor as a prototype property.</span>
357+
- <span class="signature">[`isAbsoluteHttpURI( value )`][@stdlib/assert/is-absolute-http-uri]</span><span class="delimiter">: </span><span class="description">test whether a value is an absolute HTTP(S) URI.</span>
357358
- <span class="signature">[`isAbsolutePath( value )`][@stdlib/assert/is-absolute-path]</span><span class="delimiter">: </span><span class="description">test if a value is an absolute path.</span>
359+
- <span class="signature">[`isAbsoluteURI( value )`][@stdlib/assert/is-absolute-uri]</span><span class="delimiter">: </span><span class="description">test whether a value is an absolute URI.</span>
358360
- <span class="signature">[`isAccessorPropertyIn( value, property )`][@stdlib/assert/is-accessor-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property has an accessor descriptor.</span>
359361
- <span class="signature">[`isAccessorProperty( value, property )`][@stdlib/assert/is-accessor-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property has an accessor descriptor.</span>
360362
- <span class="signature">[`isAlphagram( value )`][@stdlib/assert/is-alphagram]</span><span class="delimiter">: </span><span class="description">test if a value is an alphagram.</span>
@@ -398,6 +400,7 @@ The remaining namespace utilities are as follows:
398400
- <span class="signature">[`isIteratorLike( value )`][@stdlib/assert/is-iterator-like]</span><span class="delimiter">: </span><span class="description">test if a value is `iterator`-like.</span>
399401
- <span class="signature">[`isJSON( value )`][@stdlib/assert/is-json]</span><span class="delimiter">: </span><span class="description">test if a value is a parseable JSON string.</span>
400402
- <span class="signature">[`isLeapYear( [value] )`][@stdlib/assert/is-leap-year]</span><span class="delimiter">: </span><span class="description">test if a value corresponds to a leap year in the Gregorian calendar.</span>
403+
- <span class="signature">[`isLocalhost( value )`][@stdlib/assert/is-localhost]</span><span class="delimiter">: </span><span class="description">test whether a value is a localhost hostname.</span>
401404
- <span class="signature">[`isLowercase( value )`][@stdlib/assert/is-lowercase]</span><span class="delimiter">: </span><span class="description">test if a value is a lowercase string.</span>
402405
- <span class="signature">[`isMethodIn( value, property )`][@stdlib/assert/is-method-in]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name, either own or inherited.</span>
403406
- <span class="signature">[`isMethod( value, property )`][@stdlib/assert/is-method]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name.</span>
@@ -423,6 +426,7 @@ The remaining namespace utilities are as follows:
423426
- <span class="signature">[`isPrimitive( value )`][@stdlib/assert/is-primitive]</span><span class="delimiter">: </span><span class="description">test if a value is a JavaScript primitive.</span>
424427
- <span class="signature">[`isPRNGLike( value )`][@stdlib/assert/is-prng-like]</span><span class="delimiter">: </span><span class="description">test if a value is PRNG-like.</span>
425428
- <span class="signature">[`isProbability( value )`][@stdlib/assert/is-probability]</span><span class="delimiter">: </span><span class="description">test if a value is a probability.</span>
429+
- <span class="signature">[`isPropertyKey( value )`][@stdlib/assert/is-property-key]</span><span class="delimiter">: </span><span class="description">test whether a value is a property key.</span>
426430
- <span class="signature">[`isPrototypeOf( obj, prototype )`][@stdlib/assert/is-prototype-of]</span><span class="delimiter">: </span><span class="description">test if an object's prototype chain contains a provided prototype.</span>
427431
- <span class="signature">[`isReadOnlyPropertyIn( value, property )`][@stdlib/assert/is-read-only-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is read-only.</span>
428432
- <span class="signature">[`isReadOnlyProperty( value, property )`][@stdlib/assert/is-read-only-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is read-only.</span>
@@ -432,6 +436,7 @@ The remaining namespace utilities are as follows:
432436
- <span class="signature">[`isReadableProperty( value, property )`][@stdlib/assert/is-readable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is readable.</span>
433437
- <span class="signature">[`isRegExpString( value )`][@stdlib/assert/is-regexp-string]</span><span class="delimiter">: </span><span class="description">test if a value is a regular expression string.</span>
434438
- <span class="signature">[`isRelativePath( value )`][@stdlib/assert/is-relative-path]</span><span class="delimiter">: </span><span class="description">test if a value is a relative path.</span>
439+
- <span class="signature">[`isRelativeURI( value )`][@stdlib/assert/is-relative-uri]</span><span class="delimiter">: </span><span class="description">test whether a value is a relative URI.</span>
435440
- <span class="signature">[`isSameValueZero( a, b )`][@stdlib/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
436441
- <span class="signature">[`isSameValue( a, b )`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
437442
- <span class="signature">[`isStrictEqual( a, b )`][@stdlib/assert/is-strict-equal]</span><span class="delimiter">: </span><span class="description">test if two arguments are strictly equal.</span>
@@ -503,8 +508,12 @@ console.log( objectKeys( assert ) );
503508

504509
[@stdlib/assert/instance-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/instance-of
505510

511+
[@stdlib/assert/is-absolute-http-uri]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-absolute-http-uri
512+
506513
[@stdlib/assert/is-absolute-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-absolute-path
507514

515+
[@stdlib/assert/is-absolute-uri]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-absolute-uri
516+
508517
[@stdlib/assert/is-accessor-property-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-accessor-property-in
509518

510519
[@stdlib/assert/is-accessor-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-accessor-property
@@ -589,6 +598,8 @@ console.log( objectKeys( assert ) );
589598

590599
[@stdlib/assert/is-leap-year]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-leap-year
591600

601+
[@stdlib/assert/is-localhost]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-localhost
602+
592603
[@stdlib/assert/is-lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-lowercase
593604

594605
[@stdlib/assert/is-method-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-method-in
@@ -639,6 +650,8 @@ console.log( objectKeys( assert ) );
639650

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

653+
[@stdlib/assert/is-property-key]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-property-key
654+
642655
[@stdlib/assert/is-prototype-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-prototype-of
643656

644657
[@stdlib/assert/is-read-only-property-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-read-only-property-in
@@ -657,6 +670,8 @@ console.log( objectKeys( assert ) );
657670

658671
[@stdlib/assert/is-relative-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-relative-path
659672

673+
[@stdlib/assert/is-relative-uri]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-relative-uri
674+
660675
[@stdlib/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-value-zero
661676

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

Diff for: lib/node_modules/@stdlib/blas/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48-
- <span class="signature">[`base`][@stdlib/blas/base]</span><span class="delimiter">: </span><span class="description">"base" (i.e., lower-level) basic linear algebra subprograms (BLAS).</span>
48+
- <span class="signature">[`base`][@stdlib/blas/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) basic linear algebra subprograms (BLAS).</span>
4949
- <span class="signature">[`ddot( x, y )`][@stdlib/blas/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
5050
- <span class="signature">[`dswap( x, y )`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
51-
- <span class="signature">[`ext`][@stdlib/blas/ext]</span><span class="delimiter">: </span><span class="description">standard library extended basic linear algebra subprograms (BLAS).</span>
51+
- <span class="signature">[`ext`][@stdlib/blas/ext]</span><span class="delimiter">: </span><span class="description">extended basic linear algebra subprograms (BLAS).</span>
5252
- <span class="signature">[`gdot( x, y )`][@stdlib/blas/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two vectors.</span>
5353
- <span class="signature">[`gswap( x, y )`][@stdlib/blas/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
5454
- <span class="signature">[`sdot( x, y )`][@stdlib/blas/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>

Diff for: lib/node_modules/@stdlib/blas/ext/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48-
- <span class="signature">[`base`][@stdlib/blas/ext/base]</span><span class="delimiter">: </span><span class="description">standard library extensions to base basic linear algebra subprograms (BLAS).</span>
48+
- <span class="signature">[`base`][@stdlib/blas/ext/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS).</span>
4949

5050
</div>
5151

Diff for: lib/node_modules/@stdlib/constants/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ Constants are split across the the following sub-namespaces:
5454
- <span class="signature">[`int16`][@stdlib/constants/int16]</span><span class="delimiter">: </span><span class="description">16-bit signed integer mathematical constants.</span>
5555
- <span class="signature">[`int32`][@stdlib/constants/int32]</span><span class="delimiter">: </span><span class="description">32-bit signed integer mathematical constants.</span>
5656
- <span class="signature">[`int8`][@stdlib/constants/int8]</span><span class="delimiter">: </span><span class="description">8-bit signed integer mathematical constants.</span>
57-
- <span class="signature">[`path`][@stdlib/constants/path]</span><span class="delimiter">: </span><span class="description">standard library string path constants.</span>
57+
- <span class="signature">[`path`][@stdlib/constants/path]</span><span class="delimiter">: </span><span class="description">path constants.</span>
5858
- <span class="signature">[`time`][@stdlib/constants/time]</span><span class="delimiter">: </span><span class="description">time constants.</span>
5959
- <span class="signature">[`uint16`][@stdlib/constants/uint16]</span><span class="delimiter">: </span><span class="description">16-bit unsigned integer mathematical constants.</span>
6060
- <span class="signature">[`uint32`][@stdlib/constants/uint32]</span><span class="delimiter">: </span><span class="description">32-bit unsigned integer mathematical constants.</span>
6161
- <span class="signature">[`uint8`][@stdlib/constants/uint8]</span><span class="delimiter">: </span><span class="description">8-bit unsigned integer mathematical constants.</span>
62-
- <span class="signature">[`unicode`][@stdlib/constants/unicode]</span><span class="delimiter">: </span><span class="description">standard library string unicode constants.</span>
62+
- <span class="signature">[`unicode`][@stdlib/constants/unicode]</span><span class="delimiter">: </span><span class="description">unicode constants.</span>
6363

6464
</div>
6565

Diff for: lib/node_modules/@stdlib/math/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ The namespace consists of the following sub-namespaces:
4545

4646
<div class="namespace-toc">
4747

48-
- <span class="signature">[`base`][@stdlib/math/base]</span><span class="delimiter">: </span><span class="description">standard library math base implementations.</span>
49-
- <span class="signature">[`iter`][@stdlib/math/iter]</span><span class="delimiter">: </span><span class="description">standard library math iterators.</span>
50-
- <span class="signature">[`special`][@stdlib/math/special]</span><span class="delimiter">: </span><span class="description">standard library special math functions.</span>
51-
- <span class="signature">[`strided`][@stdlib/math/strided]</span><span class="delimiter">: </span><span class="description">standard library strided math functions.</span>
52-
- <span class="signature">[`tools`][@stdlib/math/tools]</span><span class="delimiter">: </span><span class="description">standard library math tools.</span>
48+
- <span class="signature">[`base`][@stdlib/math/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) math functions.</span>
49+
- <span class="signature">[`iter`][@stdlib/math/iter]</span><span class="delimiter">: </span><span class="description">math iterators.</span>
50+
- <span class="signature">[`special`][@stdlib/math/special]</span><span class="delimiter">: </span><span class="description">special math functions.</span>
51+
- <span class="signature">[`strided`][@stdlib/math/strided]</span><span class="delimiter">: </span><span class="description">strided array math functions.</span>
52+
- <span class="signature">[`tools`][@stdlib/math/tools]</span><span class="delimiter">: </span><span class="description">math tools.</span>
5353

5454
</div>
5555

Diff for: lib/node_modules/@stdlib/math/base/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ The namespace has the following sub-namespaces:
4545

4646
<div class="namespace-toc">
4747

48-
- <span class="signature">[`assert`][@stdlib/math/base/assert]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical assertion utilities.</span>
49-
- <span class="signature">[`ops`][@stdlib/math/base/ops]</span><span class="delimiter">: </span><span class="description">standard library base math operators.</span>
50-
- <span class="signature">[`special`][@stdlib/math/base/special]</span><span class="delimiter">: </span><span class="description">standard library base special math functions.</span>
51-
- <span class="signature">[`tools`][@stdlib/math/base/tools]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical tools.</span>
52-
- <span class="signature">[`utils`][@stdlib/math/base/utils]</span><span class="delimiter">: </span><span class="description">standard library basic mathematical utilities.</span>
48+
- <span class="signature">[`assert`][@stdlib/math/base/assert]</span><span class="delimiter">: </span><span class="description">base math assertion utilities.</span>
49+
- <span class="signature">[`ops`][@stdlib/math/base/ops]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) math operators.</span>
50+
- <span class="signature">[`special`][@stdlib/math/base/special]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) special math functions.</span>
51+
- <span class="signature">[`tools`][@stdlib/math/base/tools]</span><span class="delimiter">: </span><span class="description">base math tools.</span>
52+
- <span class="signature">[`utils`][@stdlib/math/base/utils]</span><span class="delimiter">: </span><span class="description">base math utilities.</span>
5353

5454
</div>
5555

0 commit comments

Comments
 (0)