Skip to content

Commit 7399f7c

Browse files
committed
Auto-generated commit
1 parent 368ca13 commit 7399f7c

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`b5a916e`](https://github.com/stdlib-js/stdlib/commit/b5a916e413d8658977ab2383ec6fe411f90c557d) - update `ndarray/base` TypeScript declarations [(#8127)](https://github.com/stdlib-js/stdlib/pull/8127)
1314
- [`70e9b6c`](https://github.com/stdlib-js/stdlib/commit/70e9b6c1b5b3521412ed4a8fed9ab3de337ab661) - add `ndarray/base/pop` [(#8108)](https://github.com/stdlib-js/stdlib/pull/8108)
1415
- [`d3aa7cd`](https://github.com/stdlib-js/stdlib/commit/d3aa7cd53d20216c70ee74a8d4de32a80e97be71) - add `ndarray/any` [(#8113)](https://github.com/stdlib-js/stdlib/pull/8113)
1516
- [`e45fd64`](https://github.com/stdlib-js/stdlib/commit/e45fd643c455293c39224899a16bcb4f8ea9e3db) - update `ndarray` TypeScript declarations
@@ -590,6 +591,7 @@ A total of 24 issues were closed in this release:
590591

591592
<details>
592593

594+
- [`b5a916e`](https://github.com/stdlib-js/stdlib/commit/b5a916e413d8658977ab2383ec6fe411f90c557d) - **feat:** update `ndarray/base` TypeScript declarations [(#8127)](https://github.com/stdlib-js/stdlib/pull/8127) _(by stdlib-bot)_
593595
- [`5c3691e`](https://github.com/stdlib-js/stdlib/commit/5c3691efad0d8f75effc471424caa0473cb264ac) - **test:** add tests to `ndarray/every` for complete test coverage [(#8124)](https://github.com/stdlib-js/stdlib/pull/8124) _(by Muhammad Haris, Athan Reines)_
594596
- [`5b42c46`](https://github.com/stdlib-js/stdlib/commit/5b42c466e82c41e5ef0d52bac26a1d4fa03ac31a) - **test:** fix description _(by Athan Reines)_
595597
- [`bf13b2e`](https://github.com/stdlib-js/stdlib/commit/bf13b2e3801d56c8ec137e4160834c424af5f40f) - **test:** fix descriptions _(by Athan Reines)_

‎base/docs/types/index.d.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,12 @@ import dtype = require( './../../../base/dtype' );
5353
import dtypeChar = require( './../../../base/dtype-char' );
5454
import dtypeDesc = require( './../../../base/dtype-desc' );
5555
import dtypeEnum2Str = require( './../../../base/dtype-enum2str' );
56+
import dtypeEnums = require( './../../../base/dtype-enums' );
57+
import dtypeObjects = require( './../../../base/dtype-objects' );
5658
import dtypeResolveEnum = require( './../../../base/dtype-resolve-enum' );
5759
import dtypeResolveStr = require( './../../../base/dtype-resolve-str' );
5860
import dtypeStr2Enum = require( './../../../base/dtype-str2enum' );
61+
import dtypeStrings = require( './../../../base/dtype-strings' );
5962
import dtype2c = require( './../../../base/dtype2c' );
6063
import dtypes2enums = require( './../../../base/dtypes2enums' );
6164
import dtypes2signatures = require( './../../../base/dtypes2signatures' );
@@ -1193,6 +1196,33 @@ interface Namespace {
11931196
*/
11941197
dtypeEnum2Str: typeof dtypeEnum2Str;
11951198

1199+
/**
1200+
* Returns an object mapping supported data type strings to enumeration constants.
1201+
*
1202+
* ## Notes
1203+
*
1204+
* - Downstream consumers of this mapping should **not** rely on specific integer values (e.g., `INT8 == 0`). Instead, the object should be used in an opaque manner.
1205+
* - The main purpose of this function is JavaScript and C inter-operation of ndarray objects.
1206+
*
1207+
* @returns object mapping supported data type strings to enumeration constants
1208+
*
1209+
* @example
1210+
* var o = ns.dtypeEnums();
1211+
* // returns {...}
1212+
*/
1213+
dtypeEnums: typeof dtypeEnums;
1214+
1215+
/**
1216+
* Returns an object mapping supported data type strings to data type objects.
1217+
*
1218+
* @returns object mapping supported data type strings to data type objects
1219+
*
1220+
* @example
1221+
* var o = ns.dtypeObjects();
1222+
* // returns {...}
1223+
*/
1224+
dtypeObjects: typeof dtypeObjects;
1225+
11961226
/**
11971227
* Returns the enumeration constant associated with an ndarray data type value.
11981228
*
@@ -1239,6 +1269,22 @@ interface Namespace {
12391269
*/
12401270
dtypeStr2Enum: typeof dtypeStr2Enum;
12411271

1272+
/**
1273+
* Returns a list of ndarray data type strings.
1274+
*
1275+
* @param kind - data type kind
1276+
* @returns list of ndarray data type strings
1277+
*
1278+
* @example
1279+
* var list = ns.dtypeStrings();
1280+
* // returns [...]
1281+
*
1282+
* @example
1283+
* var list = ns.dtypeStrings( 'floating_point' );
1284+
* // returns [...]
1285+
*/
1286+
dtypeStrings: typeof dtypeStrings;
1287+
12421288
/**
12431289
* Returns the C data type associated with a provided data type value.
12441290
*

0 commit comments

Comments
 (0)