Skip to content
Merged
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ import hasReplaceSymbolSupport = require( '@stdlib/assert/has-replace-symbol-sup
import hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' );
import hasSetSupport = require( '@stdlib/assert/has-set-support' );
import hasSharedArrayBufferSupport = require( '@stdlib/assert/has-sharedarraybuffer-support' );
import hasSplitSymbolSupport = require( '@stdlib/assert/has-split-symbol-support' );
import hasSymbolSupport = require( '@stdlib/assert/has-symbol-support' );
import hasToPrimitiveSymbolSupport = require( '@stdlib/assert/has-to-primitive-symbol-support' );
import hasToStringTagSupport = require( '@stdlib/assert/has-tostringtag-support' );
Expand All @@ -83,6 +84,7 @@ import isAlmostEqualComplex64array = require( '@stdlib/assert/is-almost-equal-co
import isAlmostEqualComplex128array = require( '@stdlib/assert/is-almost-equal-complex128array' );
import isAlmostEqualFloat32array = require( '@stdlib/assert/is-almost-equal-float32array' );
import isAlmostEqualFloat64Array = require( '@stdlib/assert/is-almost-equal-float64array' );
import isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );
import isAlphagram = require( '@stdlib/assert/is-alphagram' );
import isAlphaNumeric = require( '@stdlib/assert/is-alphanumeric' );
import isAnagram = require( '@stdlib/assert/is-anagram' );
Expand Down Expand Up @@ -962,6 +964,17 @@ interface Namespace {
*/
hasSharedArrayBufferSupport: typeof hasSharedArrayBufferSupport;

/**
* Tests for native `Symbol.split` support.
*
* @returns boolean indicating if an environment has `Symbol.split` support
*
* @example
* var bool = ns.hasSplitSymbolSupport();
* // returns <boolean>
*/
hasSplitSymbolSupport: typeof hasSplitSymbolSupport;

/**
* Tests for native `Symbol` support.
*
Expand Down Expand Up @@ -1505,6 +1518,41 @@ interface Namespace {
*/
isAlmostEqualFloat64Array: typeof isAlmostEqualFloat64Array;

/**
* Tests if two arguments are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param a - first input value
* @param b - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value within a specified number of ULPs
*
* @example
* var EPS = require( '@stdlib/constants/float64/eps' );
*
* var bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 0 );
* // returns false
*
* bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 1 );
* // returns true
*
* bool = ns.isAlmostSameValue( {}, {}, 0 );
* // returns false
*
* bool = ns.isAlmostSameValue( -0.0, 0.0, 0 );
* // returns false
*
* bool = ns.isAlmostSameValue( NaN, NaN, 0 );
* // returns true
*
* bool = ns.isAlmostSameValue( [], [], 1 );
* // returns false
*/
isAlmostSameValue: typeof isAlmostSameValue;

/**
* Tests if a value is an alphagram (i.e., a sequence of characters arranged in alphabetical order).
*
Expand Down
Loading