Skip to content

Commit 34719c7

Browse files
authored
feat: update assert TypeScript declarations
PR-URL: #9197 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e41ec1a commit 34719c7

File tree

1 file changed

+48
-0
lines changed
  • lib/node_modules/@stdlib/assert/docs/types

1 file changed

+48
-0
lines changed

lib/node_modules/@stdlib/assert/docs/types/index.d.ts

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ import hasReplaceSymbolSupport = require( '@stdlib/assert/has-replace-symbol-sup
5959
import hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' );
6060
import hasSetSupport = require( '@stdlib/assert/has-set-support' );
6161
import hasSharedArrayBufferSupport = require( '@stdlib/assert/has-sharedarraybuffer-support' );
62+
import hasSplitSymbolSupport = require( '@stdlib/assert/has-split-symbol-support' );
6263
import hasSymbolSupport = require( '@stdlib/assert/has-symbol-support' );
6364
import hasToPrimitiveSymbolSupport = require( '@stdlib/assert/has-to-primitive-symbol-support' );
6465
import hasToStringTagSupport = require( '@stdlib/assert/has-tostringtag-support' );
@@ -83,6 +84,7 @@ import isAlmostEqualComplex64array = require( '@stdlib/assert/is-almost-equal-co
8384
import isAlmostEqualComplex128array = require( '@stdlib/assert/is-almost-equal-complex128array' );
8485
import isAlmostEqualFloat32array = require( '@stdlib/assert/is-almost-equal-float32array' );
8586
import isAlmostEqualFloat64Array = require( '@stdlib/assert/is-almost-equal-float64array' );
87+
import isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );
8688
import isAlphagram = require( '@stdlib/assert/is-alphagram' );
8789
import isAlphaNumeric = require( '@stdlib/assert/is-alphanumeric' );
8890
import isAnagram = require( '@stdlib/assert/is-anagram' );
@@ -962,6 +964,17 @@ interface Namespace {
962964
*/
963965
hasSharedArrayBufferSupport: typeof hasSharedArrayBufferSupport;
964966

967+
/**
968+
* Tests for native `Symbol.split` support.
969+
*
970+
* @returns boolean indicating if an environment has `Symbol.split` support
971+
*
972+
* @example
973+
* var bool = ns.hasSplitSymbolSupport();
974+
* // returns <boolean>
975+
*/
976+
hasSplitSymbolSupport: typeof hasSplitSymbolSupport;
977+
965978
/**
966979
* Tests for native `Symbol` support.
967980
*
@@ -1505,6 +1518,41 @@ interface Namespace {
15051518
*/
15061519
isAlmostEqualFloat64Array: typeof isAlmostEqualFloat64Array;
15071520

1521+
/**
1522+
* Tests if two arguments are approximately the same value within a specified number of ULPs (units in the last place).
1523+
*
1524+
* ## Notes
1525+
*
1526+
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
1527+
*
1528+
* @param a - first input value
1529+
* @param b - second input value
1530+
* @param maxULP - maximum allowed ULP difference
1531+
* @returns boolean indicating whether two arguments are approximately the same value within a specified number of ULPs
1532+
*
1533+
* @example
1534+
* var EPS = require( '@stdlib/constants/float64/eps' );
1535+
*
1536+
* var bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 0 );
1537+
* // returns false
1538+
*
1539+
* bool = ns.isAlmostSameValue( 1.0, 1.0+EPS, 1 );
1540+
* // returns true
1541+
*
1542+
* bool = ns.isAlmostSameValue( {}, {}, 0 );
1543+
* // returns false
1544+
*
1545+
* bool = ns.isAlmostSameValue( -0.0, 0.0, 0 );
1546+
* // returns false
1547+
*
1548+
* bool = ns.isAlmostSameValue( NaN, NaN, 0 );
1549+
* // returns true
1550+
*
1551+
* bool = ns.isAlmostSameValue( [], [], 1 );
1552+
* // returns false
1553+
*/
1554+
isAlmostSameValue: typeof isAlmostSameValue;
1555+
15081556
/**
15091557
* Tests if a value is an alphagram (i.e., a sequence of characters arranged in alphabetical order).
15101558
*

0 commit comments

Comments
 (0)