Add Typescript definitions

Planeshifter · Planeshifter · commit 88d3a95313ff · 2019-06-08T13:59:57.000+02:00
diff --git a/lib/node_modules/@stdlib/utils/if-else/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/if-else/docs/types/index.d.ts
@@ -0,0 +1,40 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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
+
+/**
+* If a condition is truthy, returns `x`; otherwise, returns `y`.
+*
+* @param bool - condition
+* @param x - value to return if a condition is truthy
+* @param y - value to return if a condition is falsy
+* @returns either `x` or `y`
+*
+* @example
+* var randu = require( `@stdlib/random/base/randu` );
+*
+* var z = ifelse( randu() > 0.5, 1.0, -1.0 );
+* // returns <number>
+*/
+declare function ifelse( bool: boolean, x: any, y: any ): any;
+
+
+// EXPORTS //
+
+export = ifelse;
diff --git a/lib/node_modules/@stdlib/utils/if-else/docs/types/test.ts b/lib/node_modules/@stdlib/utils/if-else/docs/types/test.ts
@@ -0,0 +1,46 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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 ifelse = require( './index' );
+
+
+// TESTS //
+
+// The function returns either the `x` or `y` value...
+{
+	ifelse( true, 0, 1 ); // $ExpectType any
+	ifelse( true, 'a', 'b' ); // $ExpectType any
+	ifelse( false, 0, 1 ); // $ExpectType any
+	ifelse( false, 'a', 'b' ); // $ExpectType any
+}
+
+// The compiler throws an error if the function is not provided a boolean as its first argument...
+{
+	ifelse( ( x: number ): number => x, 0, 1 ); // $ExpectError
+	ifelse( 'abc', 0, 1 ); // $ExpectError
+	ifelse( 3.12, 0, 1 ); // $ExpectError
+	ifelse( [], 0, 1 ); // $ExpectError
+	ifelse( {}, 0, 1 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an incorrect number of arguments...
+{
+	ifelse(); // $ExpectError
+	ifelse( true, 2 ); // $ExpectError
+	ifelse( true, 0, 1, 'a' ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/if-else/package.json b/lib/node_modules/@stdlib/utils/if-else/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/utils/if-then/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/if-then/docs/types/index.d.ts
@@ -0,0 +1,48 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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
+
+/**
+* If a condition is truthy, invokes `x`; otherwise, invokes `y`.
+*
+* @param bool - condition
+* @param x - function to invoke if a condition is truthy
+* @param y - function to invoke if a condition is falsy
+* @returns return value of either `x` or `y`
+*
+* @example
+* var randu = require( `@stdlib/random/base/randu` );
+*
+* function x() {
+*     return randu() * 100.0;
+* }
+*
+* function y() {
+*     return -1.0 * randu() * 100.0;
+* }
+*
+* var z = ifthen( randu() > 0.5, x, y );
+* // returns <number>
+*/
+declare function ifthen( bool: boolean, x: Function, y: Function ): any;
+
+
+// EXPORTS //
+
+export = ifthen;
diff --git a/lib/node_modules/@stdlib/utils/if-then/docs/types/test.ts b/lib/node_modules/@stdlib/utils/if-then/docs/types/test.ts
@@ -0,0 +1,82 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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 ifthen = require( './index' );
+
+/**
+* Returns the number one.
+*
+* @returns one
+*/
+function one(): number {
+	return 1;
+}
+
+/**
+* Returns the number zero.
+*
+* @returns zero
+*/
+function zero(): number {
+	return 0;
+}
+
+
+// TESTS //
+
+// The function returns the return value of either the `x` or `y` function...
+{
+	ifthen( true, zero, one ); // $ExpectType any
+	ifthen( false, zero, one ); // $ExpectType any
+}
+
+// The compiler throws an error if the function is not provided a function as its first argument...
+{
+	ifthen( zero, zero, one ); // $ExpectError
+	ifthen( 'abc', zero, one ); // $ExpectError
+	ifthen( 3.12, zero, one ); // $ExpectError
+	ifthen( [], zero, one ); // $ExpectError
+	ifthen( {}, zero, one ); // $ExpectError
+}
+
+// The compiler throws an error if the function is not provided a function as its second argument...
+{
+	ifthen( true, 'abc', one ); // $ExpectError
+	ifthen( true, 3.12, one ); // $ExpectError
+	ifthen( true, false, one ); // $ExpectError
+	ifthen( true, true, one ); // $ExpectError
+	ifthen( true, [], one ); // $ExpectError
+	ifthen( true, {}, one ); // $ExpectError
+}
+
+// The compiler throws an error if the function is not provided a function as its third argument...
+{
+	ifthen( true, zero, 'abc' ); // $ExpectError
+	ifthen( true, zero, 3.12 ); // $ExpectError
+	ifthen( true, zero, false ); // $ExpectError
+	ifthen( true, zero, true ); // $ExpectError
+	ifthen( true, zero, [] ); // $ExpectError
+	ifthen( true, zero, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an incorrect number of arguments...
+{
+	ifthen(); // $ExpectError
+	ifthen( true, zero ); // $ExpectError
+	ifthen( true, zero, one, 'a' ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/if-then/package.json b/lib/node_modules/@stdlib/utils/if-then/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
