Add Typescript definitions

Planeshifter · Planeshifter · commit 04e97055acb5 · 2021-01-12T19:52:13.000-05:00
diff --git a/lib/node_modules/@stdlib/array/ctors/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/ctors/docs/types/index.d.ts
@@ -0,0 +1,40 @@
+/*
+* @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 an array constructor.
+*
+* @param dtype - data type
+* @returns constructor or null
+*
+* @example
+* var ctor = ctors( 'float64' );
+* // returns <Function>
+*
+* @example
+* var ctor = ctors( 'float' );
+* // returns null
+*/
+declare function ctors( dtype: string ): Function | null;
+
+
+// EXPORTS //
+
+export = ctors;
diff --git a/lib/node_modules/@stdlib/array/ctors/docs/types/test.ts b/lib/node_modules/@stdlib/array/ctors/docs/types/test.ts
@@ -0,0 +1,33 @@
+/*
+* @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 ctors = require( './index' );
+
+// TESTS //
+
+// The function returns a function or null..
+{
+	ctors( 'float64' ); // $ExpectType Function | null
+	ctors( 'float' ); // $ExpectType Function | null
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	ctors(); // $ExpectError
+	ctors( 'int32', 3 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/array/ctors/package.json b/lib/node_modules/@stdlib/array/ctors/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
diff --git a/lib/node_modules/@stdlib/array/dtype/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/dtype/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
+
+/// <reference types="@stdlib/types"/>
+
+import { TypedArray } from '@stdlib/types/array';
+
+/**
+* Returns the data type of an array.
+*
+* ## Notes
+*
+* -   If provided an argument having an unknown or unsupported type, the function returns `null`.
+*
+* @param value - input value
+* @returns data type
+*
+* @example
+* var dt = dtype( [ 1, 2, 3 ] );
+* // returns 'generic'
+*
+* var dt = dtype( 'beep' );
+* // returns null
+*/
+declare function dtype( value: TypedArray | Array<any> ): string | null;
+
+
+// EXPORTS //
+
+export = dtype;
diff --git a/lib/node_modules/@stdlib/array/dtype/docs/types/test.ts b/lib/node_modules/@stdlib/array/dtype/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @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 dtype = require( './index' );
+
+// TESTS //
+
+// The function returns a string or null..
+{
+	const x = new Float64Array( 10 );
+
+	dtype( x ); // $ExpectType string | null
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	dtype(); // $ExpectError
+	dtype( [ 1, 2, 3 ], 3 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/array/dtype/package.json b/lib/node_modules/@stdlib/array/dtype/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
