Add Typescript definitions

Planeshifter · Planeshifter · commit 43e13579a347 · 2019-03-04T10:38:42.000-05:00
diff --git a/lib/node_modules/@stdlib/assert/is-array-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-array/docs/types/index.d.ts
@@ -0,0 +1,42 @@
+/*
+* @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 value is an array of arrays.
+*
+* @param value - value to test
+* @returns boolean indicating whether a value is an array of arrays
+*
+* @example
+* var bool = isArrayArray( [ [], [] ] );
+* // returns true
+*
+* bool = isArrayArray( [ {}, {} ] );
+* // returns false
+*
+* bool = isArrayArray( [] );
+* // returns false
+*/
+declare function isArrayArray( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArrayArray;
diff --git a/lib/node_modules/@stdlib/assert/is-array-array/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-array-array/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @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 isArrayArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isArrayArray( {} ); // $ExpectType boolean
+	isArrayArray( [ [], [] ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isArrayArray(); // $ExpectError
+	isArrayArray( [ [], [] ], 123 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/assert/is-array-array/package.json b/lib/node_modules/@stdlib/assert/is-array-array/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/assert/is-array-length/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-length/docs/types/index.d.ts
@@ -0,0 +1,44 @@
+/*
+* @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 value is a valid array length.
+*
+* ## Notes
+*
+* -   A valid length property for an Array instance is any integer value on the interval [0, 2^32-1].
+*
+* @param value - value to test
+* @returns boolean indicating if a value is a valid array length
+*
+* @example
+* var bool = isArrayLength( 3 );
+* // returns true
+*
+* @example
+* var bool = isArrayLength( 3.14 );
+* // returns false
+*/
+declare function isArrayLength( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArrayLength;
diff --git a/lib/node_modules/@stdlib/assert/is-array-length/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-array-length/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @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 isArrayLength = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isArrayLength( 3 ); // $ExpectType boolean
+	isArrayLength( 3.14 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isArrayLength(); // $ExpectError
+	isArrayLength( 9, 123 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/assert/is-array-length/package.json b/lib/node_modules/@stdlib/assert/is-array-length/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/assert/is-array-like-object/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-like-object/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 value is an array-like object.
+*
+* ## Notes
+*
+* -   If provided a string, the function returns `false`.
+*
+* @param value - value to test
+* @returns boolean indicating if a value is an array-like object
+*
+* @example
+* var bool = isArrayLikeObject( [] );
+* // returns true
+*
+* @example
+* var bool = isArrayLikeObject( { 'length':10 } );
+* // returns true
+*
+* @example
+* var bool = isArrayLikeObject( 'beep' );
+* // returns false
+*/
+declare function isArrayLike( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArrayLike;
diff --git a/lib/node_modules/@stdlib/assert/is-array-like-object/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-array-like-object/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @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 isArrayLikeObject = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isArrayLikeObject( [] ); // $ExpectType boolean
+	isArrayLikeObject( 'beep' ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isArrayLikeObject(); // $ExpectError
+	isArrayLikeObject( [], 123 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/assert/is-array-like-object/package.json b/lib/node_modules/@stdlib/assert/is-array-like-object/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/assert/is-array-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-like/docs/types/index.d.ts
@@ -0,0 +1,44 @@
+/*
+* @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 value is array-like.
+*
+* ## Notes
+*
+* -   If provided a string, the function returns `true`.
+*
+* @param value - value to test
+* @returns boolean indicating if a value is array-like
+*
+* @example
+* var bool = isArrayLike( [] );
+* // returns true
+*
+* @example
+* var bool = isArrayLike( {'length':10} );
+* // returns true
+*/
+declare function isArrayLike( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArrayLike;
diff --git a/lib/node_modules/@stdlib/assert/is-array-like/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-array-like/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @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 isArrayLike = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isArrayLike( [] ); // $ExpectType boolean
+	isArrayLike( {} ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isArrayLike(); // $ExpectError
+	isArrayLike( [], 123 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/assert/is-array-like/package.json b/lib/node_modules/@stdlib/assert/is-array-like/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/assert/is-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array/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
+
+/**
+* Tests if a value is an array.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is an array
+*
+* @example
+* var bool = isArray( [] );
+* // returns true
+*
+* @example
+* var bool = isArray( {} );
+* // returns false
+*/
+declare function isArray( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArray;
diff --git a/lib/node_modules/@stdlib/assert/is-array/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-array/docs/types/test.ts
diff --git a/lib/node_modules/@stdlib/assert/is-array/package.json b/lib/node_modules/@stdlib/assert/is-array/package.json
diff --git a/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/test.ts
diff --git a/lib/node_modules/@stdlib/assert/is-arraybuffer/package.json b/lib/node_modules/@stdlib/assert/is-arraybuffer/package.json
