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 33248b5 commit 2b04a61
Show file tree
Hide file tree
Showing 3 changed files with 697 additions and 0 deletions.
61 changes: 61 additions & 0 deletions base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@
/* eslint-disable max-lines */

import contains = require( './../../../../base/assert/contains' );
import hasSameValues = require( './../../../../base/assert/has-same-values' );
import isAccessorArray = require( './../../../../base/assert/is-accessor-array' );
import isComplex64Array = require( './../../../../base/assert/is-complex64array' );
import isComplex128Array = require( './../../../../base/assert/is-complex128array' );

/**
* Interface describing the `assert` namespace.
Expand Down Expand Up @@ -51,6 +54,26 @@ interface Namespace {
*/
contains: typeof contains;

/**
* Tests if two arrays have the same values.
*
* ## Notes
*
* - If provided arrays of unequal length, the function returns `false`.
*
* @param x - first input array
* @param y - second input array
* @returns boolean indicating whether both arrays have the same values
*
* @example
* var x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 1, 0 ];
*
* var out = ns.hasSameValues( x, y );
* // returns true
*/
hasSameValues: typeof hasSameValues;

/**
* Tests if an array-like object supports the accessor (get/set) protocol.
*
Expand All @@ -69,6 +92,44 @@ interface Namespace {
* // returns false
*/
isAccessorArray: typeof isAccessorArray;

/**
* Tests if a value is a `Complex64Array`.
*
* @param value - value to test
* @returns boolean indicating whether a value is a `Complex64Array`
*
* @example
* var Complex64Array = require( './../../../../complex64' );
*
* var arr = new Complex64Array( 10 );
* var bool = ns.isComplex64Array( arr );
* // returns true
*
* @example
* var bool = ns.isComplex64Array( [] );
* // returns false
*/
isComplex64Array: typeof isComplex64Array;

/**
* Tests if a value is a `Complex128Array`.
*
* @param value - value to test
* @returns boolean indicating whether a value is a `Complex128Array`
*
* @example
* var Complex128Array = require( './../../../../complex128' );
*
* var arr = new Complex128Array( 10 );
* var bool = ns.isComplex128Array( arr );
* // returns true
*
* @example
* var bool = ns.isComplex128Array( [] );
* // returns false
*/
isComplex128Array: typeof isComplex128Array;
}

/**
Expand Down
Loading

0 comments on commit 2b04a61

Please sign in to comment.