Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/array/safe-casts/docs/types/index.d.ts

@@ -0,0 +1,41 @@
+/*
+* @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 array data types to which a provided array data type can be safely cast.
+*
+* ## Notes
+*
+* -   If not provided an array data type, the function returns a casting table.
+* -   If provided an unrecognized array data type, the function returns `null`.
+*
+* @param dtype - array data type
+* @returns list of array data types or null
+*
+* @example
+* var list = safeCasts( 'float32' );
+* // returns [...]
+*/
+declare function safeCasts( dtype?: string ): Object | Array<string> | null;
+
+
+// EXPORTS //
+
+export = safeCasts;

lib/node_modules/@stdlib/array/safe-casts/docs/types/test.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.
+*/
+
+import safeCasts = require( './index' );
+
+// TESTS //
+
+// The function returns a string array, object, or null..
+{
+	safeCasts(); // $ExpectType Object | string[] | null
+	safeCasts( 'float32' ); // $ExpectType Object | string[] | null
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a string...
+{
+	safeCasts( 123 );  // $ExpectError
+	safeCasts( true ); // $ExpectError
+	safeCasts( false ); // $ExpectError
+	safeCasts( {} ); // $ExpectError
+	safeCasts( [] ); // $ExpectError
+	safeCasts( null ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	safeCasts( 'float32', 3 ); // $ExpectError
+}

lib/node_modules/@stdlib/array/safe-casts/package.json

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

lib/node_modules/@stdlib/array/same-kind-casts/docs/types/index.d.ts

@@ -0,0 +1,41 @@
+/*
+* @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 array data types to which a provided array data type can be safely cast or cast within the same "kind".
+*
+* ## Notes
+*
+* -   If not provided an array data type, the function returns a casting table.
+* -   If provided an unrecognized array data type, the function returns `null`.
+*
+* @param dtype - array data type
+* @returns list of array data types or null
+*
+* @example
+* var list = sameKindCasts( 'float32' );
+* // returns [...]
+*/
+declare function sameKindCasts( dtype?: string ): Object | Array<string> | null;
+
+
+// EXPORTS //
+
+export = sameKindCasts;

lib/node_modules/@stdlib/array/same-kind-casts/docs/types/test.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.
+*/
+
+import sameKindCasts = require( './index' );
+
+// TESTS //
+
+// The function returns a string array, object, or null..
+{
+	sameKindCasts(); // $ExpectType Object | string[] | null
+	sameKindCasts( 'float32' ); // $ExpectType Object | string[] | null
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a string...
+{
+	sameKindCasts( 123 );  // $ExpectError
+	sameKindCasts( true ); // $ExpectError
+	sameKindCasts( false ); // $ExpectError
+	sameKindCasts( {} ); // $ExpectError
+	sameKindCasts( [] ); // $ExpectError
+	sameKindCasts( null ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	sameKindCasts( 'float32', 3 ); // $ExpectError
+}

lib/node_modules/@stdlib/array/same-kind-casts/package.json

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