Add Typescript definition

Planeshifter · Planeshifter · commit 599d5ac7fc51 · 2021-04-11T12:25:51.000-04:00
diff --git a/lib/node_modules/@stdlib/stats/ztest/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/ztest/docs/types/index.d.ts
@@ -107,7 +107,7 @@ interface Output {
 * @param options.alpha - significance level (default: 0.05)
 * @param options.alternative - alternative hypothesis (`two-sided`, `less` or `greater`; default: 'two-sided')
 * @param options.mu - mean under H0 (default: 0)
-* @throws sigma argument has to be a positive number
+* @throws sigma argument must be a positive number
 * @throws must provide valid options
 * @returns test result object
 *
diff --git a/lib/node_modules/@stdlib/stats/ztest2/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/ztest2/docs/types/index.d.ts
@@ -114,8 +114,8 @@ interface Output {
 * @param options.alpha - significance level (default: 0.05)
 * @param options.alternative - alternative hypothesis (`two-sided`, `less` or `greater`; default: 'two-sided')
 * @param options.difference - difference in means under H0 (default: 0)
-* @throws sigmax argument has to be a positive number
-* @throws sigmay argument has to be a positive number
+* @throws sigmax argument must be a positive number
+* @throws sigmay argument must be a positive number
 * @throws must provide valid options
 * @returns test result object
 *
diff --git a/lib/node_modules/@stdlib/utils/from-entries/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/from-entries/docs/types/index.d.ts
@@ -0,0 +1,38 @@
+/*
+* @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
+
+/**
+* Creates an object from an array of key-value pairs.
+*
+* @param entries - input object
+* @returns object created from `[key, value]` pairs
+*
+* @example
+* var entries = [ ['beep', 'boop'], ['foo', 'bar'] ];
+*
+* var obj = objectFromEntries( entries );
+* // returns {'beep': 'boop', 'foo': 'bar'}
+*/
+declare function objectFromEntries( entries: Array<Array<any>> ): any;
+
+
+// EXPORTS //
+
+export = objectFromEntries;
diff --git a/lib/node_modules/@stdlib/utils/from-entries/docs/types/test.ts b/lib/node_modules/@stdlib/utils/from-entries/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 objectFromEntries = require( './index' );
+
+
+// TESTS //
+
+// The function returns an object...
+{
+	objectFromEntries( [ ['beep', 'boop'], ['foo', 'bar'] ] ); // $ExpectType any
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of arrays...
+{
+	objectFromEntries( 'abc' ); // $ExpectError
+	objectFromEntries( 123 ); // $ExpectError
+	objectFromEntries( true ); // $ExpectError
+	objectFromEntries( false ); // $ExpectError
+	objectFromEntries( {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	objectFromEntries(); // $ExpectError
+	objectFromEntries( [ ['beep', 'boop'], ['foo', 'bar'] ], {} ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/from-entries/package.json b/lib/node_modules/@stdlib/utils/from-entries/package.json
@@ -20,6 +20,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ interface Output {`
`107`	`107`	`* @param options.alpha - significance level (default: 0.05)`
`108`	`108`	* @param options.alternative - alternative hypothesis (`two-sided`, `less` or `greater`; default: 'two-sided')
`109`	`109`	`* @param options.mu - mean under H0 (default: 0)`
`110`		`-* @throws sigma argument has to be a positive number`
	`110`	`+* @throws sigma argument must be a positive number`
`111`	`111`	`* @throws must provide valid options`
`112`	`112`	`* @returns test result object`
`113`	`113`	`*`