Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/assert/is-circular-array/docs/types/index.d.ts

@@ -0,0 +1,57 @@
+/*
+* @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 containing a circular reference.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is an array containing a circular reference
+*
+* @example
+* var arr = [ 1, 2, 3 ];
+* arr.push( arr );
+* var bool = isCircularArray( arr );
+* // returns true
+*
+* @example
+* var obj = {
+*   'a': 'beep',
+*   'b': {
+*     'c': 'boop'
+*   }
+* };
+* obj.b.self = obj;
+* var bool = isCircularArray( obj );
+* // returns false
+*
+* @example
+* var bool = isCircularArray( [] );
+* // returns false
+*
+* @example
+* var bool = isCircularArray( null );
+* // returns false
+*/
+declare function isCircularArray( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isCircularArray;

lib/node_modules/@stdlib/assert/is-circular-array/docs/types/test.ts

@@ -0,0 +1,36 @@
+/*
+* @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 isCircularArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	const arr: Array<any> = [ 1, 2, 3 ];
+	arr.push( arr );
+	isCircularArray( arr ); // $ExpectType boolean
+	isCircularArray( [] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isCircularArray(); // $ExpectError
+	isCircularArray( [], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-circular-array/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/assert/is-circular/docs/types/index.d.ts

@@ -0,0 +1,57 @@
+/*
+* @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 an object-like value contains a circular reference.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is object-like and contains a circular reference
+*
+* @example
+* var obj = {
+*   'a': 'beep',
+*   'b': {
+*     'c': 'boop'
+*   }
+* };
+* obj.b.self = obj;
+* var bool = isCircular( obj );
+* // returns true
+*
+* @example
+* var arr = [ 1, 2, 3 ];
+* arr.push( arr );
+* var bool = isCircular( arr );
+* // returns true
+*
+* @example
+* var bool = isCircular( {} );
+* // returns false
+*
+* @example
+* var bool = isCircular( null );
+* // returns false
+*/
+declare function isCircular( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isCircular;

lib/node_modules/@stdlib/assert/is-circular/docs/types/test.ts

@@ -0,0 +1,47 @@
+/*
+* @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 isCircular = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	const obj = {
+		'a': 'beep',
+		'b': {
+			'c': 'boop',
+			'self': {}
+		}
+	};
+	obj.b.self = obj;
+	isCircular( obj ); // $ExpectType boolean
+
+	const arr: Array<any> = [ 1, 2, 3 ];
+	arr.push( arr );
+	isCircular( arr ); // $ExpectType boolean
+
+	isCircular( [] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isCircular(); // $ExpectError
+	isCircular( [], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-circular/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/assert/is-collection/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 a collection.
+*
+* @param value - value to test
+* @returns boolean indicating whether a value is a collection
+*
+* @example
+* var bool = isCollection( [] );
+* // returns true
+*
+* @example
+* var bool = isCollection( {} );
+* // returns false
+*/
+declare function isCollection( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isCollection;

lib/node_modules/@stdlib/assert/is-collection/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 isCollection = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isCollection( [] ); // $ExpectType boolean
+	isCollection( {} ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isCollection(); // $ExpectError
+	isCollection( [], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-collection/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/assert/is-prng-like/docs/types/index.d.ts

@@ -0,0 +1,41 @@
+/*
+* @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 PRNG-like.
+*
+* @param v - value to test
+* @returns boolean indicating if a value is PRNG-like
+*
+* @example
+* var randu = require( '@stdlib/random/base/randu' );
+*
+* var bool = isPRNGLike( randu );
+* // returns true
+*
+* bool = isPRNGLike( [] );
+* // returns false
+*/
+declare function isPRNGLike( v: any ): boolean;
+
+
+// EXPORTS //
+
+export = isPRNGLike;