Update namespace TypeScript declarations (stdlib-js#564)

github-actions[bot] · kgryte · web-flow · commit 5a43b305f85c · 2022-10-26T12:50:42.000-07:00
Co-authored-by: kgryte &lt;kgryte@users.noreply.github.com&gt;
diff --git a/lib/node_modules/@stdlib/assert/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/docs/types/index.d.ts
@@ -94,6 +94,7 @@ import isBooleanArray = require( '@stdlib/assert/is-boolean-array' );
 import isBoxedPrimitive = require( '@stdlib/assert/is-boxed-primitive' );
 import IS_BROWSER = require( '@stdlib/assert/is-browser' );
 import isBuffer = require( '@stdlib/assert/is-buffer' );
+import isCamelcase = require( '@stdlib/assert/is-camelcase' );
 import isCapitalized = require( '@stdlib/assert/is-capitalized' );
 import isCentrosymmetricMatrix = require( '@stdlib/assert/is-centrosymmetric-matrix' );
 import isCircular = require( '@stdlib/assert/is-circular' );
@@ -112,6 +113,7 @@ import isComplex128Array = require( '@stdlib/assert/is-complex128array' );
 import isComposite = require( '@stdlib/assert/is-composite' );
 import isConfigurableProperty = require( '@stdlib/assert/is-configurable-property' );
 import isConfigurablePropertyIn = require( '@stdlib/assert/is-configurable-property-in' );
+import isConstantcase = require( '@stdlib/assert/is-constantcase' );
 import isCubeNumber = require( '@stdlib/assert/is-cube-number' );
 import isCurrentYear = require( '@stdlib/assert/is-current-year' );
 import IS_DARWIN = require( '@stdlib/assert/is-darwin' );
@@ -122,6 +124,7 @@ import isDateObject = require( '@stdlib/assert/is-date-object' );
 import isDateObjectArray = require( '@stdlib/assert/is-date-object-array' );
 import isDigitString = require( '@stdlib/assert/is-digit-string' );
 import IS_DOCKER = require( '@stdlib/assert/is-docker' );
+import isDomainName = require( '@stdlib/assert/is-domain-name' );
 import IS_ELECTRON = require( '@stdlib/assert/is-electron' );
 import IS_ELECTRON_MAIN = require( '@stdlib/assert/is-electron-main' );
 import IS_ELECTRON_RENDERER = require( '@stdlib/assert/is-electron-renderer' );
@@ -164,6 +167,7 @@ import isIntegerArray = require( '@stdlib/assert/is-integer-array' );
 import isIterableLike = require( '@stdlib/assert/is-iterable-like' );
 import isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
 import isJSON = require( '@stdlib/assert/is-json' );
+import isKebabcase = require( '@stdlib/assert/is-kebabcase' );
 import isLeapYear = require( '@stdlib/assert/is-leap-year' );
 import IS_LITTLE_ENDIAN = require( '@stdlib/assert/is-little-endian' );
 import isLocalhost = require( '@stdlib/assert/is-localhost' );
@@ -212,6 +216,7 @@ import isObject = require( '@stdlib/assert/is-object' );
 import isObjectArray = require( '@stdlib/assert/is-object-array' );
 import isObjectLike = require( '@stdlib/assert/is-object-like' );
 import isOdd = require( '@stdlib/assert/is-odd' );
+import isPascalcase = require( '@stdlib/assert/is-pascalcase' );
 import isPersymmetricMatrix = require( '@stdlib/assert/is-persymmetric-matrix' );
 import isPlainObject = require( '@stdlib/assert/is-plain-object' );
 import isPlainObjectArray = require( '@stdlib/assert/is-plain-object-array' );
@@ -251,6 +256,7 @@ import isSharedArrayBuffer = require( '@stdlib/assert/is-sharedarraybuffer' );
 import isSkewCentrosymmetricMatrix = require( '@stdlib/assert/is-skew-centrosymmetric-matrix' );
 import isSkewPersymmetricMatrix = require( '@stdlib/assert/is-skew-persymmetric-matrix' );
 import isSkewSymmetricMatrix = require( '@stdlib/assert/is-skew-symmetric-matrix' );
+import isSnakecase = require( '@stdlib/assert/is-snakecase' );
 import isSquareMatrix = require( '@stdlib/assert/is-square-matrix' );
 import isSquareNumber = require( '@stdlib/assert/is-square-number' );
 import isSquareTriangularNumber = require( '@stdlib/assert/is-square-triangular-number' );
@@ -288,6 +294,7 @@ import isWritableProperty = require( '@stdlib/assert/is-writable-property' );
 import isWritablePropertyIn = require( '@stdlib/assert/is-writable-property-in' );
 import isWriteOnlyProperty = require( '@stdlib/assert/is-write-only-property' );
 import isWriteOnlyPropertyIn = require( '@stdlib/assert/is-write-only-property-in' );
+import tools = require( '@stdlib/assert/tools' );
 
 /**
 * Interface describing the `assert` namespace.
@@ -1724,6 +1731,30 @@ interface Namespace {
 	*/
 	isBuffer: typeof isBuffer;
 
+	/**
+	* Tests if a value is a camelcase string.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is a camelcase string
+	*
+	* @example
+	* var bool = ns.isCamelcase( 'beepBoop' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isCamelcase( 'HelloWorld' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isCamelcase( 'Hello World' );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isCamelcase( 'hello world' );
+	* // returns false
+	*/
+	isCamelcase: typeof isCamelcase;
+
 	/**
 	* Tests if a value is a string having an uppercase first character.
 	*
@@ -2161,6 +2192,36 @@ interface Namespace {
 	*/
 	isConfigurablePropertyIn: typeof isConfigurablePropertyIn;
 
+	/**
+	* Tests if a value is a constantcase string.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is a constantcase string
+	*
+	* @example
+	* var bool = ns.isConstantcase( 'BEEP_BOOP' );
+	* // returns true
+	*
+	* bool = ns.isConstantcase( 'beep_boop' );
+	* // returns false
+	*
+	* bool = ns.isConstantcase( 'BEEP-BOOP' );
+	* // returns false
+	*
+	* bool = ns.isConstantcase( 'beep boop' );
+	* // returns false
+	*
+	* bool = ns.isConstantcase( 'beep' );
+	* // returns false
+	*
+	* bool = ns.isConstantcase( '' );
+	* // returns false
+	*
+	* bool = ns.isConstantcase( null );
+	* // returns false
+	*/
+	isConstantcase: typeof isConstantcase;
+
 	/**
 	* Tests if a value is a cube number.
 	*
@@ -2370,6 +2431,22 @@ interface Namespace {
 	*/
 	IS_DOCKER: typeof IS_DOCKER;
 
+	/**
+	* Tests if a value is a domain name.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is a domain name
+	*
+	* @example
+	* var bool = ns.isDomainName( 'beep.boop' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isDomainName( 'foo@bar.com' );
+	* // returns false
+	*/
+	isDomainName: typeof isDomainName;
+
 	/**
 	* Boolean indicating if the runtime is Electron.
 	*
@@ -3318,6 +3395,30 @@ interface Namespace {
 	*/
 	isJSON: typeof isJSON;
 
+	/**
+	* Tests if a value is a string in kebab case.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is a string in kebab case
+	*
+	* @example
+	* var bool = ns.isKebabcase( `beep-boop` );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isKebabcase( `Beep-boop` );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isKebabcase( `BEEP_BOOP` );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isKebabcase( 1 );
+	* // returns false
+	*/
+	isKebabcase: typeof isKebabcase;
+
 	/**
 	* Tests whether a value corresponds to a leap year in the Gregorian calendar.
 	*
@@ -4482,6 +4583,30 @@ interface Namespace {
 	*/
 	isOdd: typeof isOdd;
 
+	/**
+	* Tests if a value is a string in Pascal case.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is a string in Pascal case
+	*
+	* @example
+	* var bool = ns.isPascalcase( 'HelloWorld' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isPascalcase( 'helloWorld' );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isPascalcase( 'HELLO_WORLD' );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isPascalcase( null );
+	* // returns false
+	*/
+	isPascalcase: typeof isPascalcase;
+
 	/**
 	* Tests if a value is a persymmetric matrix.
 	*
@@ -5579,6 +5704,34 @@ interface Namespace {
 	*/
 	isSkewSymmetricMatrix: typeof isSkewSymmetricMatrix;
 
+	/**
+	* Tests if a value is a string in snake case.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether a value is a string in snake case
+	*
+	* @example
+	* var bool = ns.isSnakecase( 'hello_world' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSnakecase( 'Hello World' );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isSnakecase( 'Hello_World' );
+	* // returns false
+	*
+	* @example
+	* var bool = ns.isSnakecase( '' );
+	* // returns true
+	*
+	* @example
+	* var bool = ns.isSnakecase( null );
+	* // returns false
+	*/
+	isSnakecase: typeof isSnakecase;
+
 	/**
 	* Tests if a value is a 2-dimensional ndarray-like object having equal dimensions.
 	*
@@ -6548,6 +6701,11 @@ interface Namespace {
 	* // returns true
 	*/
 	isWriteOnlyPropertyIn: typeof isWriteOnlyPropertyIn;
+
+	/**
+	* Assertion utility tools.
+	*/
+	tools: typeof tools;
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/number/float64/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/number/float64/base/docs/types/index.d.ts
@@ -249,18 +249,22 @@ interface Namespace {
 	/**
 	* Returns a normal number `y` and exponent `exp` satisfying \\(x = y \cdot 2^\mathrm{exp}\\).
 	*
-	* The first element of the returned array corresponds to `y` and the second to `exp`.
+	* ## Notes
+	*
+	* -   The first element of the returned array corresponds to `y` and the second to `exp`.
 	*
 	* @param x - input value
 	* @returns output array
 	*
 	* @example
 	* var pow = require( `@stdlib/math/base/special/pow` );
+	*
 	* var out = ns.normalize( 3.14e-319 );
 	* // returns <Float64Array>[ 1.4141234400356668e-303, -52 ]
 	*
 	* var y = out[ 0 ];
 	* var exponent = out[ 1 ];
+	*
 	* var bool = ( y*pow(2.0, exponent) === 3.14e-319 );
 	* // returns true
 	*/
diff --git a/lib/node_modules/@stdlib/time/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/time/base/docs/types/index.d.ts
@@ -21,10 +21,14 @@
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-file-line-count */
 
+
+
 /**
 * Interface describing the `base` namespace.
 */
-interface Namespace {}
+interface Namespace {
+
+}
 
 /**
 * Base (i.e., lower-level) time utilities.

Original file line number	Diff line number	Diff line change
`@@ -249,18 +249,22 @@ interface Namespace {`
`249`	`249`	`/**`
`250`	`250`	* Returns a normal number `y` and exponent `exp` satisfying \\(x = y \cdot 2^\mathrm{exp}\\).
`251`	`251`	`*`
`252`		- * The first element of the returned array corresponds to `y` and the second to `exp`.
	`252`	`+ * ## Notes`
	`253`	`+ *`
	`254`	+ * - The first element of the returned array corresponds to `y` and the second to `exp`.
`253`	`255`	`*`
`254`	`256`	`* @param x - input value`
`255`	`257`	`* @returns output array`
`256`	`258`	`*`
`257`	`259`	`* @example`
`258`	`260`	* var pow = require( `@stdlib/math/base/special/pow` );
	`261`	`+ *`
`259`	`262`	`* var out = ns.normalize( 3.14e-319 );`
`260`	`263`	`* // returns <Float64Array>[ 1.4141234400356668e-303, -52 ]`
`261`	`264`	`*`
`262`	`265`	`* var y = out[ 0 ];`
`263`	`266`	`* var exponent = out[ 1 ];`
	`267`	`+ *`
`264`	`268`	`* var bool = ( y*pow(2.0, exponent) === 3.14e-319 );`
`265`	`269`	`* // returns true`
`266`	`270`	`*/`