Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update namespace TypeScript declarations #4706

Merged
merged 1 commit into from
Jan 12, 2025
Merged
Show file tree
Hide file tree
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
33 changes: 33 additions & 0 deletions lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import isRealFloatingPointDataType = require( '@stdlib/array/base/assert/is-real
import isSafeDataTypeCast = require( '@stdlib/array/base/assert/is-safe-data-type-cast' );
import isSameKindDataTypeCast = require( '@stdlib/array/base/assert/is-same-kind-data-type-cast' );
import isSignedIntegerDataType = require( '@stdlib/array/base/assert/is-signed-integer-data-type' );
import isSortedAscending = require( '@stdlib/array/base/assert/is-sorted-ascending' );
import isUnsignedIntegerDataType = require( '@stdlib/array/base/assert/is-unsigned-integer-data-type' );

/**
Expand Down Expand Up @@ -689,6 +690,38 @@ interface Namespace {
*/
isSignedIntegerDataType: typeof isSignedIntegerDataType;

/**
* Tests if an array is sorted in ascending order.
*
* @param x - input array
* @returns boolean indicating if an array is sorted in ascending order
*
* @example
* var out = ns.isSortedAscending( [ 1, 2, 3 ] );
* // returns true
*
* @example
* var out = ns.isSortedAscending( [ 3, 2, 1 ] );
* // returns false
*
* @example
* var out = ns.isSortedAscending( [ 3, 3, 3 ] );
* // returns true
*
* @example
* var out = ns.isSortedAscending( [ 3 ] );
* // returns true
*
* @example
* var out = ns.isSortedAscending( [] );
* // returns false
*
* @example
* var out = ns.isSortedAscending( [ 1, 3, 2 ] );
* // returns false
*/
isSortedAscending: typeof isSortedAscending;

/**
* Tests whether an input value is a supported array unsigned integer data type.
*
Expand Down
Loading
Loading