Skip to content

Commit 32f2bab

Browse files
committed
feat: update ndarray/base TypeScript declarations
Signed-off-by: stdlib-bot <[email protected]>
1 parent 5c3691e commit 32f2bab

File tree

1 file changed

+46
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base/docs/types

1 file changed

+46
-0
lines changed

lib/node_modules/@stdlib/ndarray/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( '@stdlib/ndarray/base/dtype' );
5353
import dtypeChar = require( '@stdlib/ndarray/base/dtype-char' );
5454
import dtypeDesc = require( '@stdlib/ndarray/base/dtype-desc' );
5555
import dtypeEnum2Str = require( '@stdlib/ndarray/base/dtype-enum2str' );
56+
import dtypeEnums = require( '@stdlib/ndarray/base/dtype-enums' );
57+
import dtypeObjects = require( '@stdlib/ndarray/base/dtype-objects' );
5658
import dtypeResolveEnum = require( '@stdlib/ndarray/base/dtype-resolve-enum' );
5759
import dtypeResolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
5860
import dtypeStr2Enum = require( '@stdlib/ndarray/base/dtype-str2enum' );
61+
import dtypeStrings = require( '@stdlib/ndarray/base/dtype-strings' );
5962
import dtype2c = require( '@stdlib/ndarray/base/dtype2c' );
6063
import dtypes2enums = require( '@stdlib/ndarray/base/dtypes2enums' );
6164
import dtypes2signatures = require( '@stdlib/ndarray/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)