From 60f57670fd7e869427d086a91caa71949a6d3421 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 2 Jun 2026 11:39:24 -0500 Subject: [PATCH] docs: fix TSDoc errors in `@stdlib/assert` declarations Correct documentation-only defects across `@stdlib/assert` ambient declaration files (TSDoc comments only; no type or runtime changes): - Fix copy-pasted/wrong `@returns` and summary prose: `is-symbol-array` ("array of strings" -> symbols), `is-probability-array` ("positive integer" -> probabilities), `is-undefined-or-null` (omitted "or null"), `is-nonpositive-number-array` ("integer" -> "number"), and `is-nonpositive-finite` (missing "finite"). - Fix incorrect `@example` annotations: `is-positive-finite` (`Infinity` marked "returns true"), `is-iterable-like` (placeholder ``), and `is-nan-array` (missing `// returns`). - In `is-bigint` and `is-symbol`, demonstrate the main function in the top-level `@example` blocks (previously only sub-methods were shown) and remove a duplicated `@example` block. - Repair `HasFunction` summaries/examples in `deep-has-own-property` and `deep-has-property` to describe the returned one-argument tester. - Miscellaneous: strip JSDoc-style `{*}`/`{boolean}` tags in `is-nonnegative-finite`, convert backtick example strings to single quotes in `is-kebabcase`, give continuation examples their own `@example` tags in `is-startcase`, add the missing `## Notes` block in `is-same-typed-array-like`, and remove stray/double whitespace. --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../assert/contains/docs/types/index.d.ts | 2 +- .../docs/types/index.d.ts | 6 ++++-- .../deep-has-property/docs/types/index.d.ts | 9 +++++++-- .../assert/is-bigint/docs/types/index.d.ts | 20 +------------------ .../is-boolean-array/docs/types/index.d.ts | 2 +- .../is-integer-array/docs/types/index.d.ts | 1 + .../is-iterable-like/docs/types/index.d.ts | 2 +- .../assert/is-kebabcase/docs/types/index.d.ts | 6 +++--- .../assert/is-leap-year/docs/types/index.d.ts | 2 +- .../assert/is-nan-array/docs/types/index.d.ts | 1 + .../docs/types/index.d.ts | 19 +++++++++--------- .../docs/types/index.d.ts | 2 +- .../docs/types/index.d.ts | 8 ++++---- .../is-number-array/docs/types/index.d.ts | 1 + .../is-positive-finite/docs/types/index.d.ts | 2 +- .../docs/types/index.d.ts | 6 +++--- .../docs/types/index.d.ts | 2 +- .../docs/types/index.d.ts | 4 ++++ .../assert/is-startcase/docs/types/index.d.ts | 6 ++++-- .../is-symbol-array/docs/types/index.d.ts | 6 +++--- .../assert/is-symbol/docs/types/index.d.ts | 20 +------------------ .../docs/types/index.d.ts | 2 +- 22 files changed, 54 insertions(+), 75 deletions(-) diff --git a/lib/node_modules/@stdlib/assert/contains/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/contains/docs/types/index.d.ts index 05e36cf30d0c..176df0835de3 100644 --- a/lib/node_modules/@stdlib/assert/contains/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/contains/docs/types/index.d.ts @@ -36,7 +36,7 @@ import { ArrayLike } from '@stdlib/types/array'; * @param value - input value * @param searchValue - search value * @param position - position at which to start searching for `searchValue` (default: 0) -* @throws second argument must be a primitive string primitive when the first argument is a string +* @throws second argument must be a string primitive when the first argument is a string * @returns boolean indicating whether one value contains another * * @example diff --git a/lib/node_modules/@stdlib/assert/deep-has-own-property/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/deep-has-own-property/docs/types/index.d.ts index b8ad4f47f76c..7b7ae2470b38 100644 --- a/lib/node_modules/@stdlib/assert/deep-has-own-property/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/deep-has-own-property/docs/types/index.d.ts @@ -29,14 +29,16 @@ interface Options { } /** -* Returns a boolean indicating whether an object has a nested key path. +* Tests whether an object has a nested key path. * * @param value - value to test * @returns boolean indicating whether an object has a nested property * * @example * var obj = { 'a': { 'b': { 'c': 'd' } } }; -* var bool = deepHasOwnProp( obj, 'a' ); +* var has = deepHasOwnProp.factory( 'a.b.c' ); +* var bool = has( obj ); +* // returns true */ type HasFunction = ( value: any ) => boolean; diff --git a/lib/node_modules/@stdlib/assert/deep-has-property/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/deep-has-property/docs/types/index.d.ts index 41c7c3a64ea5..c7d7fba41c85 100644 --- a/lib/node_modules/@stdlib/assert/deep-has-property/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/deep-has-property/docs/types/index.d.ts @@ -29,14 +29,16 @@ interface Options { } /** -* Returns a boolean indicating whether an object has a nested key path, either own or inherited. +* Tests whether an object has a nested key path, either own or inherited. * * @param value - value to test * @returns boolean indicating whether an object has a nested property * * @example * var obj = { 'a': { 'b': { 'c': 'd' } } }; -* var bool = deepHasProp( obj, 'a' ); +* var has = deepHasProp.factory( 'a.b.c' ); +* var bool = has( obj ); +* // returns true */ type HasFunction = ( value: any ) => boolean; @@ -114,9 +116,12 @@ interface DeepHasProp { * @returns function which tests whether an object has a nested key path * * @example + * var obj = { 'a': { 'b': { 'c': 'd' } } }; * var has = deepHasProp.factory( 'a/b/c', { * 'sep': '/' * }); + * var bool = has( obj ); + * // returns true */ factory( path: string | Array, options?: Options ): HasFunction; } diff --git a/lib/node_modules/@stdlib/assert/is-bigint/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-bigint/docs/types/index.d.ts index 781f29bdad15..e307a4a95b5d 100644 --- a/lib/node_modules/@stdlib/assert/is-bigint/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-bigint/docs/types/index.d.ts @@ -104,36 +104,18 @@ interface IsBigInt { * @example * var BigInt = require( '@stdlib/bigint/ctor' ); * -* var bool = isBigInt.isPrimitive( BigInt( '1' ) ); +* var bool = isBigInt( BigInt( '1' ) ); * // returns true * * @example * var BigInt = require( '@stdlib/bigint/ctor' ); * -* var bool = isBigInt.isPrimitive( Object( BigInt( '1' ) ) ); -* // returns false -* -* @example -* var BigInt = require( '@stdlib/bigint/ctor' ); -* * var bool = isBigInt.isPrimitive( BigInt( '1' ) ); * // returns true * * @example * var BigInt = require( '@stdlib/bigint/ctor' ); * -* var bool = isBigInt.isPrimitive( Object( BigInt( '1' ) ) ); -* // returns false -* -* @example -* var BigInt = require( '@stdlib/bigint/ctor' ); -* -* var bool = isBigInt.isObject( BigInt( '1' ) ); -* // returns false -* -* @example -* var BigInt = require( '@stdlib/bigint/ctor' ); -* * var bool = isBigInt.isObject( Object( BigInt( '1' ) ) ); * // returns true */ diff --git a/lib/node_modules/@stdlib/assert/is-boolean-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-boolean-array/docs/types/index.d.ts index a4bc2fa12bf6..423d905cfb5c 100644 --- a/lib/node_modules/@stdlib/assert/is-boolean-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-boolean-array/docs/types/index.d.ts @@ -26,7 +26,7 @@ interface IsBooleanArray { * Tests if a value is an array-like object of booleans. * * @param value - value to test - * @returns boolean indicating whether value is an array-like object of booleans + * @returns boolean indicating whether value is an array-like object of booleans * * @example * var bool = isBooleanArray( [ true, false, true ] ); diff --git a/lib/node_modules/@stdlib/assert/is-integer-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-integer-array/docs/types/index.d.ts index fcdf2a87e975..c4a074821af4 100644 --- a/lib/node_modules/@stdlib/assert/is-integer-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-integer-array/docs/types/index.d.ts @@ -92,6 +92,7 @@ interface IsIntegerArray { * @example * var bool = isIntegerArray( [ -3.0, '3.0' ] ); * // returns false +* * @example * var bool = isIntegerArray.primitives( [ -1.0, 0.0, 5.0 ] ); * // returns true diff --git a/lib/node_modules/@stdlib/assert/is-iterable-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-iterable-like/docs/types/index.d.ts index 3ea70194750a..7a312516468b 100644 --- a/lib/node_modules/@stdlib/assert/is-iterable-like/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-iterable-like/docs/types/index.d.ts @@ -33,7 +33,7 @@ * * @example * var bool = isIterableLike( [] ); -* // returns +* // returns true * * @example * var bool = isIterableLike( {} ); diff --git a/lib/node_modules/@stdlib/assert/is-kebabcase/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-kebabcase/docs/types/index.d.ts index 74fabeb7eef2..4e5ae336b70d 100644 --- a/lib/node_modules/@stdlib/assert/is-kebabcase/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-kebabcase/docs/types/index.d.ts @@ -25,15 +25,15 @@ * @returns boolean indicating whether a value is a string in kebab case * * @example -* var bool = isKebabcase( `beep-boop` ); +* var bool = isKebabcase( 'beep-boop' ); * // returns true * * @example -* var bool = isKebabcase( `Beep-boop` ); +* var bool = isKebabcase( 'Beep-boop' ); * // returns false * * @example -* var bool = isKebabcase( `BEEP_BOOP` ); +* var bool = isKebabcase( 'BEEP_BOOP' ); * // returns false * * @example diff --git a/lib/node_modules/@stdlib/assert/is-leap-year/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-leap-year/docs/types/index.d.ts index 7f8f62d1ddd3..91c6fd12afe4 100644 --- a/lib/node_modules/@stdlib/assert/is-leap-year/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-leap-year/docs/types/index.d.ts @@ -26,7 +26,7 @@ * - According to the Gregorian calendar, every year that is exactly divisible by `4` is a leap year, except those years which are also divisible by `100` and not by `400` (e.g., `1900`). * * @param value - input value -* @returns boolean whether a value corresponds to a leap year +* @returns boolean indicating whether a value corresponds to a leap year * * @example * var bool = isLeapYear(); diff --git a/lib/node_modules/@stdlib/assert/is-nan-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nan-array/docs/types/index.d.ts index c7dd138b832a..730a2262458c 100644 --- a/lib/node_modules/@stdlib/assert/is-nan-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nan-array/docs/types/index.d.ts @@ -70,6 +70,7 @@ interface IsNaNArray { * * @example * var bool = isNaNArray.objects( [ NaN, NaN, NaN ] ); + * // returns false */ objects( value: any ): value is ArrayLike; } diff --git a/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts index d3f994a7125e..fd0a5c3ba776 100644 --- a/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts @@ -25,8 +25,8 @@ interface IsNonNegativeFinite { /** * Tests if a value is a nonnegative finite number. * - * @param {*} value - value to test - * @returns {boolean} boolean indicating whether value is a nonnegative finite number + * @param value - value to test + * @returns boolean indicating whether value is a nonnegative finite number * * @example * var bool = isNonNegativeFinite( 5.0 ); @@ -57,8 +57,8 @@ interface IsNonNegativeFinite { /** * Tests if a value is a number primitive having a nonnegative finite value. * - * @param {*} value - value to test - * @returns {boolean} boolean indicating if a value is a number primitive having a nonnegative finite value + * @param value - value to test + * @returns boolean indicating if a value is a number primitive having a nonnegative finite value * * @example * var bool = isNonNegativeFinite.isPrimitive( 3.0 ); @@ -79,10 +79,10 @@ interface IsNonNegativeFinite { isPrimitive( value: any ): boolean; /** - * Tests if a value is a finite number object having a nonnegative value. + * Tests if a value is a number object having a nonnegative finite value. * - * @param {*} value - value to test - * @returns {boolean} boolean indicating if a value is a number object having a nonnegative finite number value + * @param value - value to test + * @returns boolean indicating if a value is a number object having a nonnegative finite number value * * @example * var bool = isNonNegativeFinite.isObject( 3.0 ); @@ -106,8 +106,8 @@ interface IsNonNegativeFinite { /** * Tests if a value is a nonnegative finite number. * -* @param {*} value - value to test -* @returns {boolean} boolean indicating whether value is a nonnegative finite number +* @param value - value to test +* @returns boolean indicating whether value is a nonnegative finite number * * @example * var bool = isNonNegativeFinite( 5.0 ); @@ -133,7 +133,6 @@ interface IsNonNegativeFinite { * var bool = isNonNegativeFinite( null ); * // returns false */ - declare var isNonNegativeFinite: IsNonNegativeFinite; diff --git a/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts index b7532e99be85..5048390c515c 100644 --- a/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts @@ -70,7 +70,7 @@ interface IsNonPositiveFinite { * Tests if a value is a number object having a nonpositive finite value. * * @param value - value to test - * @returns boolean indicating if a value is a number object having a nonpositive number value + * @returns boolean indicating if a value is a number object having a nonpositive finite number value * * @example * var bool = isNonPositiveFinite.isObject( -3.0 ); diff --git a/lib/node_modules/@stdlib/assert/is-nonpositive-number-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonpositive-number-array/docs/types/index.d.ts index faf556b3601a..57efb5b78ab2 100644 --- a/lib/node_modules/@stdlib/assert/is-nonpositive-number-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonpositive-number-array/docs/types/index.d.ts @@ -39,10 +39,10 @@ interface IsNonPositiveNumberArray { ( value: any ): value is ArrayLike; /** - * Tests if a value is an array-like object containing only nonpositive primitive integer values. + * Tests if a value is an array-like object containing only nonpositive primitive number values. * * @param value - value to test - * @returns boolean indicating whether value is an array-like object containing only nonpositive primitive integer values + * @returns boolean indicating whether value is an array-like object containing only nonpositive primitive number values * * @example * var bool = isNonPositiveNumberArray.primitives( [ -1.0, -10.0 ] ); @@ -59,10 +59,10 @@ interface IsNonPositiveNumberArray { primitives( value: any ): value is ArrayLike; /** - * Tests if a value is an array-like object containing only number objects having nonpositive integer values. + * Tests if a value is an array-like object containing only number objects having nonpositive number values. * * @param value - value to test - * @returns boolean indicating whether value is an array-like object containing only number objects having nonpositive integer values + * @returns boolean indicating whether value is an array-like object containing only number objects having nonpositive number values * * @example * var bool = isNonPositiveNumberArray.objects( [ new Number(-1.0), new Number(-10.0) ] ); diff --git a/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts index 82356455b296..c4f093c2cd86 100644 --- a/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts @@ -92,6 +92,7 @@ interface IsNumberArray { * @example * var bool = isNumberArray( [ -3.0, '3.0' ] ); * // returns false +* * @example * var bool = isNumberArray.primitives( [ -1.0, 0.0, 5.0 ] ); * // returns true diff --git a/lib/node_modules/@stdlib/assert/is-positive-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-positive-finite/docs/types/index.d.ts index 5fe01da214ce..39c63ab52efd 100644 --- a/lib/node_modules/@stdlib/assert/is-positive-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-positive-finite/docs/types/index.d.ts @@ -70,7 +70,7 @@ interface IsPositiveFinite { * * @example * var bool = isPositiveFinite.isPrimitive( 1.0/0.0 ); - * // returns true + * // returns false * * @example * var bool = isPositiveFinite.isPrimitive( new Number( 3.0 ) ); diff --git a/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts index 797be9e3a5c2..ba2fba5bdd60 100644 --- a/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts @@ -23,7 +23,7 @@ */ interface IsProbabilityArray { /** - * Test if a value is an array-like object containing only probabilities. + * Tests if a value is an array-like object containing only probabilities. * * @param value - value to test * @returns boolean indicating whether value is an array-like object containing only probabilities @@ -72,10 +72,10 @@ interface IsProbabilityArray { } /** -* Test if a value is an array-like object containing only probabilities. +* Tests if a value is an array-like object containing only probabilities. * * @param value - value to test -* @returns boolean indicating whether value is a positive integer +* @returns boolean indicating whether value is an array-like object containing only probabilities * * @example * var bool = isProbabilityArray( [ 0.3, new Number(0.3) ] ); diff --git a/lib/node_modules/@stdlib/assert/is-readable-property/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-readable-property/docs/types/index.d.ts index 02988a87347c..1ab458535c5b 100644 --- a/lib/node_modules/@stdlib/assert/is-readable-property/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-readable-property/docs/types/index.d.ts @@ -23,7 +23,7 @@ * * @param value - value to test * @param property - property to test -* @returns boolean indicating if an object property is readable +* @returns boolean indicating if an object property is readable * * @example * var defineProperty = require( '@stdlib/utils/define-property' ); diff --git a/lib/node_modules/@stdlib/assert/is-same-typed-array-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-same-typed-array-like/docs/types/index.d.ts index 4d439e423311..2cff982b1605 100644 --- a/lib/node_modules/@stdlib/assert/is-same-typed-array-like/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-same-typed-array-like/docs/types/index.d.ts @@ -21,6 +21,10 @@ /** * Tests if two arguments are both typed-array-like objects and have the same values. * +* ## Notes +* +* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same. +* * @param v1 - first input value * @param v2 - second input value * @returns boolean indicating whether the two arguments are both typed-array-like objects with the same values diff --git a/lib/node_modules/@stdlib/assert/is-startcase/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-startcase/docs/types/index.d.ts index 97263735d674..460989c888e3 100644 --- a/lib/node_modules/@stdlib/assert/is-startcase/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-startcase/docs/types/index.d.ts @@ -28,10 +28,12 @@ * var bool = isStartcase( 'Beep Boop' ); * // returns true * -* bool = isStartcase( 'beep boop' ); +* @example +* var bool = isStartcase( 'beep boop' ); * // returns false * -* bool = isStartcase( 'Beep and Boop' ); +* @example +* var bool = isStartcase( 'Beep and Boop' ); * // returns false */ declare function isStartcase( value: any ): boolean; diff --git a/lib/node_modules/@stdlib/assert/is-symbol-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-symbol-array/docs/types/index.d.ts index 85d2b08490d5..4ec3be2b022e 100644 --- a/lib/node_modules/@stdlib/assert/is-symbol-array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-symbol-array/docs/types/index.d.ts @@ -30,7 +30,7 @@ interface IsSymbolArray { * - In pre-ES2015 environments, the function always returns `false`. * * @param value - value to test - * @returns boolean indicating whether value is an array of strings + * @returns boolean indicating whether value is an array-like object containing only symbols * * @example * var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] ); @@ -50,7 +50,7 @@ interface IsSymbolArray { * - In pre-ES2015 environments, the function always returns `false`. * * @param value - value to test - * @returns boolean indicating whether value is an array containing only string primitives + * @returns boolean indicating whether value is an array-like object containing only symbol primitives * * @example * var bool = isSymbolArray.primitives( [ Symbol( 'abc' ), Symbol( 'def' ) ] ); @@ -92,7 +92,7 @@ interface IsSymbolArray { * - In pre-ES2015 environments, the function always returns `false`. * * @param value - value to test -* @returns boolean indicating whether value is an array of strings +* @returns boolean indicating whether value is an array-like object containing only symbols * * @example * var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] ); diff --git a/lib/node_modules/@stdlib/assert/is-symbol/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-symbol/docs/types/index.d.ts index 4bb29d20f951..d39350cc47b1 100644 --- a/lib/node_modules/@stdlib/assert/is-symbol/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-symbol/docs/types/index.d.ts @@ -104,36 +104,18 @@ interface IsSymbol { * @example * var Symbol = require( '@stdlib/symbol/ctor' ); * -* var bool = isSymbol.isPrimitive( Symbol( 'beep' ) ); +* var bool = isSymbol( Symbol( 'beep' ) ); * // returns true * * @example * var Symbol = require( '@stdlib/symbol/ctor' ); * -* var bool = isSymbol.isPrimitive( Object( Symbol( 'beep' ) ) ); -* // returns false -* -* @example -* var Symbol = require( '@stdlib/symbol/ctor' ); -* * var bool = isSymbol.isPrimitive( Symbol( 'beep' ) ); * // returns true * * @example * var Symbol = require( '@stdlib/symbol/ctor' ); * -* var bool = isSymbol.isPrimitive( Object( Symbol( 'beep' ) ) ); -* // returns false -* -* @example -* var Symbol = require( '@stdlib/symbol/ctor' ); -* -* var bool = isSymbol.isObject( Symbol( 'beep' ) ); -* // returns false -* -* @example -* var Symbol = require( '@stdlib/symbol/ctor' ); -* * var bool = isSymbol.isObject( Object( Symbol( 'beep' ) ) ); * // returns true */ diff --git a/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts index 0671fbd3276f..d1858efe1cfa 100644 --- a/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts @@ -22,7 +22,7 @@ * Tests if a value is `undefined` or `null`. * * @param value - value to test -* @returns boolean indicating whether value is undefined +* @returns boolean indicating whether value is undefined or null * * @example * var bool = isUndefinedOrNull( undefined );