Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/ndarray/casting-modes/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Returns a list of ndarray casting modes.
+*
+* ## Notes
+*
+* -   The output array contains the following modes:
+*
+*     -   'none': only allow casting between identical types
+*     -   'equiv': allow casting between identical and byte swapped types
+*     -   'safe': only allow "safe" casts
+*     -   'same-kind': allow "safe" casts and casts within the same kind (e.g.,
+*    between signed integers or between floats)
+*     -   'unsafe': allow casting between all types (including between integers and
+*    floats)
+*
+* @returns list of ndarray casting modes
+*
+* @example
+* var list = modes();
+* // returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+*/
+declare function modes(): Array<string>;
+
+
+// EXPORTS //
+
+export = modes;

lib/node_modules/@stdlib/ndarray/casting-modes/docs/types/test.ts

@@ -0,0 +1,32 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import modes = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings...
+{
+	modes(); // $ExpectType string[]
+}
+
+// The function does not compile if provided any arguments...
+{
+	modes( 9 ); // $ExpectError
+}

lib/node_modules/@stdlib/ndarray/casting-modes/package.json

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/ndarray/dtypes/docs/types/index.d.ts

@@ -0,0 +1,51 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Returns a list of ndarray data types.
+*
+* ## Notes
+*
+* -   The output array contains the following data types:
+*
+*     -   binary: binary.
+*     -   float32: single-precision floating-point numbers.
+*     -   float64: double-precision floating-point numbers.
+*     -   generic: values of any type.
+*     -   int16: signed 16-bit integers.
+*     -   int32: signed 32-bit integers.
+*     -   int8: signed 8-bit integers.
+*     -   uint16: unsigned 16-bit integers.
+*     -   uint32: unsigned 32-bit integers.
+*     -   uint8: unsigned 8-bit integers.
+*     -   uint8c: unsigned clamped 8-bit integers.
+*
+* @returns list of ndarray data types
+*
+* @example
+* var list = dtypes();
+* // returns [...]
+*/
+declare function dtypes(): Array<string>;
+
+
+// EXPORTS //
+
+export = dtypes;

lib/node_modules/@stdlib/ndarray/dtypes/docs/types/test.ts

@@ -0,0 +1,32 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import dtypes = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings...
+{
+	dtypes(); // $ExpectType string[]
+}
+
+// The function does not compile if provided any arguments...
+{
+	dtypes( 9 ); // $ExpectError
+}

lib/node_modules/@stdlib/ndarray/dtypes/package.json

@@ -22,6 +22,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/ndarray/index-modes/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Returns a list of ndarray index modes.
+*
+* ## Notes
+*
+* -   The output array contains the following modes:
+*
+*     -   throw: specifies that a function should throw an error when an index is
+*     outside a restricted interval.
+*     -   wrap: specifies that a function should wrap around an index using modulo
+*     arithmetic.
+*     -   clamp: specifies that a function should set an index less than zero to
+*     zero (minimum index) and set an index greater than a maximum index value to
+*     the maximum possible index.
+*
+* @returns list of ndarray index modes
+*
+* @example
+* var list = modes();
+* // returns [ 'throw', 'clamp', 'wrap' ]
+*/
+declare function modes(): Array<string>;
+
+
+// EXPORTS //
+
+export = modes;

lib/node_modules/@stdlib/ndarray/index-modes/docs/types/test.ts

@@ -0,0 +1,32 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import modes = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings...
+{
+	modes(); // $ExpectType string[]
+}
+
+// The function does not compile if provided any arguments...
+{
+	modes( 9 ); // $ExpectError
+}

lib/node_modules/@stdlib/ndarray/index-modes/package.json

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

lib/node_modules/@stdlib/ndarray/orders/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Returns a list of ndarray orders.
+*
+* ## Notes
+*
+* -   The output array contains the following orders:
+*
+*     -   row-major: row-major (C-style) order.
+*     -   column-major: column-major (Fortran-style) order.
+*
+* @returns list of ndarray orders
+*
+* @example
+* var list = orders();
+* // returns [ 'row-major', 'column-major' ]
+*/
+declare function orders(): Array<string>;
+
+
+// EXPORTS //
+
+export = orders;