Add Typescript definition

Author: Planeshifter

lib/node_modules/@stdlib/array/promotion-rules/docs/types/index.d.ts

@@ -0,0 +1,52 @@
+/*
+* @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 the array data type with the smallest size and closest "kind" to which array data types can be safely cast.
+*
+* @param dtype1 - array data type
+* @param dtype2 - array data type
+* @returns promotion rule(s) or null
+*
+* @example
+* var dt = promotionRules( 'float32', 'uint32' );
+* // returns 'float64'
+*
+* @example
+* var dt = promotionRules( 'float32', 'foo' );
+* // returns null
+*/
+declare function promotionRules( dtype1: string, dtype2: string ): any;
+
+/**
+* Returns a type promotion table displaying array data types with the smallest size and closest "kind" to which array data types can be safely cast.
+*
+* @returns promotion rule table
+*
+* @example
+* var table = promotionRules();
+* // returns {...}
+*/
+declare function promotionRules(): any;
+
+
+// EXPORTS //
+
+export = promotionRules;

lib/node_modules/@stdlib/array/promotion-rules/docs/types/test.ts

@@ -0,0 +1,56 @@
+/*
+* @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 promotionRules = require( './index' );
+
+
+// TESTS //
+
+// The function returns an object, array of strings, or null...
+{
+	promotionRules(); // $ExpectType any
+	promotionRules( 'float32', 'uint32' ); // $ExpectType any
+	promotionRules( 'int32', 'generic' ); // $ExpectType any
+	promotionRules( 'float32', 'foo' ); // $ExpectType any
+}
+
+// The function does not compile if provided a first argument that is not a string...
+{
+	promotionRules( 123, 'float64' ); // $ExpectError
+	promotionRules( true, 'float64' ); // $ExpectError
+	promotionRules( false, 'float64' ); // $ExpectError
+	promotionRules( null, 'float64' ); // $ExpectError
+	promotionRules( {}, 'float64' ); // $ExpectError
+	promotionRules( ( x: number ): number => x, 'float64' ); // $ExpectError
+}
+
+// The function does not compile if provided a second argument that is not a string...
+{
+	promotionRules( 'int32', 123 ); // $ExpectError
+	promotionRules( 'int32', true ); // $ExpectError
+	promotionRules( 'int32', false ); // $ExpectError
+	promotionRules( 'int32', null ); // $ExpectError
+	promotionRules( 'int32', {} ); // $ExpectError
+	promotionRules( 'int32', ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided more than one argument...
+{
+	promotionRules( 'float32' ); // $ExpectError
+	promotionRules( 'float32', 'int32', {} ); // $ExpectError
+}

lib/node_modules/@stdlib/array/promotion-rules/package.json

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