Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/math/base/assert/is-negative-integer/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
+
+/**
+* Tests if a finite double-precision floating-point number is a negative integer.
+*
+* ## Notes
+*
+* -   The function assumes a finite number. If provided negative infinity, the function will return `true`, when, in fact, the result is undefined.
+*
+* @param x - value to test
+* @returns boolean indicating whether the value is a negative integer
+*
+* @example
+* var bool = isNegativeInteger( -1.0 );
+* // returns true
+*
+* @example
+* var bool = isNegativeInteger( 0.0 );
+* // returns false
+*
+* @example
+* var bool = isNegativeInteger( 10.0 );
+* // returns false
+*/
+declare function isNegativeInteger( x: number ): boolean;
+
+
+// EXPORTS //
+
+export = isNegativeInteger;

lib/node_modules/@stdlib/math/base/assert/is-negative-integer/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 isNegativeInteger = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isNegativeInteger( 2 ); // $ExpectType boolean
+	isNegativeInteger( 3.12 ); // $ExpectType boolean
+	isNegativeInteger( -2 ); // $ExpectType boolean
+}
+
+// The function does not compile if provided a value other than a number...
+{
+	isNegativeInteger( true ); // $ExpectError
+	isNegativeInteger( false ); // $ExpectError
+	isNegativeInteger( null ); // $ExpectError
+	isNegativeInteger( undefined ); // $ExpectError
+	isNegativeInteger( [] ); // $ExpectError
+	isNegativeInteger( {} ); // $ExpectError
+	isNegativeInteger( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isNegativeInteger(); // $ExpectError
+	isNegativeInteger( undefined, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/math/base/assert/is-negative-integer/package.json

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

lib/node_modules/@stdlib/math/base/assert/is-nonnegative-integer/docs/types/index.d.ts

@@ -0,0 +1,49 @@
+/*
+* @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
+
+/**
+* Tests if a finite double-precision floating-point number is a nonnegative integer.
+*
+* ## Notes
+*
+* -   The function assumes a finite number. If provided positive infinity, the function will return `true`, when, in fact, the result is undefined.
+* -   The function does not distinguish between positive and negative zero.
+*
+* @param x - value to test
+* @returns boolean indicating whether the value is a nonnegative integer
+*
+* @example
+* var bool = isNonNegativeInteger( 1.0 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeInteger( 0.0 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeInteger( -10.0 );
+* // returns false
+*/
+declare function isNonNegativeInteger( x: number ): boolean;
+
+
+// EXPORTS //
+
+export = isNonNegativeInteger;

lib/node_modules/@stdlib/math/base/assert/is-nonnegative-integer/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 isNonNegativeInteger = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isNonNegativeInteger( 2 ); // $ExpectType boolean
+	isNonNegativeInteger( 3.12 ); // $ExpectType boolean
+	isNonNegativeInteger( -2 ); // $ExpectType boolean
+}
+
+// The function does not compile if provided a value other than a number...
+{
+	isNonNegativeInteger( true ); // $ExpectError
+	isNonNegativeInteger( false ); // $ExpectError
+	isNonNegativeInteger( null ); // $ExpectError
+	isNonNegativeInteger( undefined ); // $ExpectError
+	isNonNegativeInteger( [] ); // $ExpectError
+	isNonNegativeInteger( {} ); // $ExpectError
+	isNonNegativeInteger( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isNonNegativeInteger(); // $ExpectError
+	isNonNegativeInteger( undefined, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/math/base/assert/is-nonnegative-integer/package.json

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

lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/docs/types/index.d.ts

@@ -0,0 +1,49 @@
+/*
+* @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
+
+/**
+* Tests if a finite double-precision floating-point number is a nonpositive integer.
+*
+* ## Notes
+*
+* -   The function assumes a finite number. If provided negative infinity, the function will return `true`, when, in fact, the result is undefined.
+* -   The function does not distinguish between positive and negative zero.
+*
+* @param x - value to test
+* @returns boolean indicating whether the value is a nonpositive integer
+*
+* @example
+* var bool = isNonPositiveInteger( -1.0 );
+* // returns true
+*
+* @example
+* var bool = isNonPositiveInteger( 0.0 );
+* // returns true
+*
+* @example
+* var bool = isNonPositiveInteger( 10.0 );
+* // returns false
+*/
+declare function isNonPositiveInteger( x: number ): boolean;
+
+
+// EXPORTS //
+
+export = isNonPositiveInteger;

lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/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 isNonPositiveInteger = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isNonPositiveInteger( 2 ); // $ExpectType boolean
+	isNonPositiveInteger( 3.12 ); // $ExpectType boolean
+	isNonPositiveInteger( -2 ); // $ExpectType boolean
+}
+
+// The function does not compile if provided a value other than a number...
+{
+	isNonPositiveInteger( true ); // $ExpectError
+	isNonPositiveInteger( false ); // $ExpectError
+	isNonPositiveInteger( null ); // $ExpectError
+	isNonPositiveInteger( undefined ); // $ExpectError
+	isNonPositiveInteger( [] ); // $ExpectError
+	isNonPositiveInteger( {} ); // $ExpectError
+	isNonPositiveInteger( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isNonPositiveInteger(); // $ExpectError
+	isNonPositiveInteger( undefined, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/math/base/assert/is-nonpositive-integer/package.json

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

lib/node_modules/@stdlib/math/base/assert/is-positive-integer/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
+
+/**
+* Tests if a finite double-precision floating-point number is a positive integer.
+*
+* ## Notes
+*
+* -   The function assumes a finite number. If provided positive infinity, the function will return `true`, when, in fact, the result is undefined.
+*
+* @param x - value to test
+* @returns boolean indicating whether the value is a positive integer
+*
+* @example
+* var bool = isPositiveInteger( 1.0 );
+* // returns true
+*
+* @example
+* var bool = isPositiveInteger( 0.0 );
+* // returns false
+*
+* @example
+* var bool = isPositiveInteger( -10.0 );
+* // returns false
+*/
+declare function isPositiveInteger( x: number ): boolean;
+
+
+// EXPORTS //
+
+export = isPositiveInteger;