Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 28, 2024
1 parent da28bfb commit 057a452
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,69 @@
/* eslint-disable max-lines */

import isSameValue = require( '@stdlib/number-float64-base-assert-is-same-value' );
import isSameValueZero = require( '@stdlib/number-float64-base-assert-is-same-value-zero' );

/**
* Interface describing the `assert` namespace.
*/
interface Namespace {
/**
* TODO
* Tests if two double-precision floating-point numbers are the same value.
*
* ## 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
* @returns boolean indicating whether two double-precision floating-point numbers are the same value
*
* @example
* var bool = ns.isSameValue( 3.14, 3.14 );
* // returns true
*
* @example
* var bool = ns.isSameValue( -0.0, -0.0 );
* // returns true
*
* @example
* var bool = ns.isSameValue( -0.0, 0.0 );
* // returns false
*
* @example
* var bool = ns.isSameValue( NaN, NaN );
* // returns true
*/
isSameValue: typeof isSameValue;

/**
* Tests if two double-precision floating-point numbers are the same value.
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats ``NaNs` as the same value.
*
* @param a - first input value
* @param b - second input value
* @returns boolean indicating whether two double-precision floating-point numbers are the same value
*
* @example
* var bool = ns.isSameValueZero( 3.14, 3.14 );
* // returns true
*
* @example
* var bool = ns.isSameValueZero( -0.0, -0.0 );
* // returns true
*
* @example
* var bool = ns.isSameValueZero( -0.0, 0.0 );
* // returns true
*
* @example
* var bool = ns.isSameValueZero( NaN, NaN );
* // returns true
*/
isSameValueZero: typeof isSameValueZero;
}

/**
Expand Down

0 comments on commit 057a452

Please sign in to comment.