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 12, 2025
1 parent 2ff5b95 commit cdd914b
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<section class="release" id="unreleased">

## Unreleased (2025-01-11)
## Unreleased (2025-01-12)

<section class="packages">

Expand All @@ -20,6 +20,7 @@

##### Features

- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706)
- [`d11aaf3`](https://github.com/stdlib-js/stdlib/commit/d11aaf3e4ea651384185655584eea9c5b8ca9ae2) - add `isSortedAscending` to namespace
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
- [`43aa58f`](https://github.com/stdlib-js/stdlib/commit/43aa58f81dcad604f11a5715a1546c015b0a9623) - add `isByteOrder` to namespace
Expand Down Expand Up @@ -172,6 +173,8 @@ A total of 3 people contributed to this release. Thank you to the following cont

<details>

- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - **feat:** update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706) _(by stdlib-bot)_
- [`cff470f`](https://github.com/stdlib-js/stdlib/commit/cff470f9608165100c8c122fce70c40b1af864ec) - **docs:** update namespace table of contents (#4708) _(by stdlib-bot, Planeshifter)_
- [`d11aaf3`](https://github.com/stdlib-js/stdlib/commit/d11aaf3e4ea651384185655584eea9c5b8ca9ae2) - **feat:** add `isSortedAscending` to namespace _(by Athan Reines)_
- [`5a848eb`](https://github.com/stdlib-js/stdlib/commit/5a848ebda6a2ff9cc34cfa5cf93ffce65b8bab0e) - **feat:** add `array/base/assert/is-sorted-ascending` _(by Athan Reines)_
- [`1d9e4dd`](https://github.com/stdlib-js/stdlib/commit/1d9e4dd5514ba4f3c1063dff732e37254dc0dd84) - **docs:** add missing comment _(by Athan Reines)_
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ The namespace exports the following:
- <span class="signature">[`isSafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-safe-data-type-cast]</span><span class="delimiter">: </span><span class="description">determine whether an array data type can be safely cast to another array data type.</span>
- <span class="signature">[`isSameKindDataTypeCast( from, to )`][@stdlib/array/base/assert/is-same-kind-data-type-cast]</span><span class="delimiter">: </span><span class="description">determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type.</span>
- <span class="signature">[`isSignedIntegerDataType( value )`][@stdlib/array/base/assert/is-signed-integer-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported array signed integer data type.</span>
- <span class="signature">[`isSortedAscending( x )`][@stdlib/array/base/assert/is-sorted-ascending]</span><span class="delimiter">: </span><span class="description">test if an array is sorted in ascending order.</span>
- <span class="signature">[`isUnsignedIntegerDataType( value )`][@stdlib/array/base/assert/is-unsigned-integer-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported array unsigned integer data type.</span>

</div>
Expand Down Expand Up @@ -319,6 +320,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].

[@stdlib/array/base/assert/is-signed-integer-data-type]: https://github.com/stdlib-js/array-base-assert-is-signed-integer-data-type

[@stdlib/array/base/assert/is-sorted-ascending]: https://github.com/stdlib-js/array-base-assert-is-sorted-ascending

[@stdlib/array/base/assert/is-unsigned-integer-data-type]: https://github.com/stdlib-js/array-base-assert-is-unsigned-integer-data-type

<!-- </toc-links> -->
Expand Down
33 changes: 33 additions & 0 deletions 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

0 comments on commit cdd914b

Please sign in to comment.