Skip to content

Commit e661213

Browse files
authored
feat: update namespace TypeScript declarations
PR-URL: #4706 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
1 parent cff470f commit e661213

File tree

6 files changed

+954
-41
lines changed

6 files changed

+954
-41
lines changed

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ import isRealFloatingPointDataType = require( '@stdlib/array/base/assert/is-real
4242
import isSafeDataTypeCast = require( '@stdlib/array/base/assert/is-safe-data-type-cast' );
4343
import isSameKindDataTypeCast = require( '@stdlib/array/base/assert/is-same-kind-data-type-cast' );
4444
import isSignedIntegerDataType = require( '@stdlib/array/base/assert/is-signed-integer-data-type' );
45+
import isSortedAscending = require( '@stdlib/array/base/assert/is-sorted-ascending' );
4546
import isUnsignedIntegerDataType = require( '@stdlib/array/base/assert/is-unsigned-integer-data-type' );
4647

4748
/**
@@ -689,6 +690,38 @@ interface Namespace {
689690
*/
690691
isSignedIntegerDataType: typeof isSignedIntegerDataType;
691692

693+
/**
694+
* Tests if an array is sorted in ascending order.
695+
*
696+
* @param x - input array
697+
* @returns boolean indicating if an array is sorted in ascending order
698+
*
699+
* @example
700+
* var out = ns.isSortedAscending( [ 1, 2, 3 ] );
701+
* // returns true
702+
*
703+
* @example
704+
* var out = ns.isSortedAscending( [ 3, 2, 1 ] );
705+
* // returns false
706+
*
707+
* @example
708+
* var out = ns.isSortedAscending( [ 3, 3, 3 ] );
709+
* // returns true
710+
*
711+
* @example
712+
* var out = ns.isSortedAscending( [ 3 ] );
713+
* // returns true
714+
*
715+
* @example
716+
* var out = ns.isSortedAscending( [] );
717+
* // returns false
718+
*
719+
* @example
720+
* var out = ns.isSortedAscending( [ 1, 3, 2 ] );
721+
* // returns false
722+
*/
723+
isSortedAscending: typeof isSortedAscending;
724+
692725
/**
693726
* Tests whether an input value is a supported array unsigned integer data type.
694727
*

0 commit comments

Comments
 (0)