Add Typescript definition

Author: Planeshifter

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

@@ -0,0 +1,101 @@
+/*
+* @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
+
+/**
+* Interface defining `isBooleanArray` with methods for testing for primitives and objects, respectively.
+*/
+interface IsBooleanArray {
+	/**
+	* Tests if a value is an array-like object of booleans.
+	*
+	* @param value - value to test
+	* @returns  boolean indicating whether value is an array-like object of booleans
+	*
+	* @example
+	* var bool = isBooleanArray( [ true, false, true ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isBooleanArray( [ true, 'abc', false ] );
+	* // returns false
+	*/
+	( value: any ): boolean;
+
+	/**
+	* Tests if a value is an array-like object containing only boolean primitives.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is an array-like object containing only boolean primitives
+	*
+	* @example
+	* var bool = isBooleanArray.primitives( [ true, false ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isBooleanArray.primitives( [ false, new Boolean( true ) ] );
+	* // returns false
+	*/
+	primitives( value: any ): boolean;
+
+	/**
+	* Tests if a value is an array-like object containing only Boolean objects.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is an array-like object containing only Boolean objects
+	*
+	* @example
+	* var bool = isBooleanArray.objects( [ new Boolean( false ), new Boolean( true ) ] );
+	* // returns true
+	*
+	* @example
+	* var bool = isBooleanArray.objects( [ new Boolean( false ), true ] );
+	* // returns false
+	*/
+	objects( value: any ): boolean;
+}
+
+/**
+* Tests if a value is an array-like object of booleans.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is an array-like object of booleans
+*
+* @example
+* var bool = isBooleanArray( [ true, false, true ] );
+* // returns true
+*
+* @example
+* var bool = isBooleanArray( [ true, 'abc', false ] );
+* // returns false
+*
+* @example
+* var bool = isBooleanArray.primitives( [ true, false ] );
+* // returns true
+*
+* @example
+* var bool = isBooleanArray.objects( [ new Boolean( false ), new Boolean( true ) ] );
+* // returns true
+*/
+declare var isBooleanArray: IsBooleanArray;
+
+
+// EXPORTS //
+
+export = isBooleanArray;

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

@@ -0,0 +1,61 @@
+/*
+* @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 isBooleanArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isBooleanArray( [ 'beep' ] ); // $ExpectType boolean
+	isBooleanArray( [ true, false, true ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isBooleanArray(); // $ExpectError
+	isBooleanArray( [ true, false ], 123 ); // $ExpectError
+}
+
+// Attached to main export is a `primitives` method which returns a boolean...
+{
+	// tslint:disable-next-line:no-construct
+	isBooleanArray.primitives( [ new Boolean( true ) ] ); // $ExpectType boolean
+	isBooleanArray.primitives( [ true ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `primitives` method is provided an unsupported number of arguments...
+{
+	isBooleanArray.primitives(); // $ExpectError
+	isBooleanArray.primitives( [ true ], 123 ); // $ExpectError
+}
+
+
+// Attached to main export is an `objects` method which returns a boolean...
+{
+	// tslint:disable-next-line:no-construct
+	isBooleanArray.objects( [ new Boolean( true ) ] ); // $ExpectType boolean
+	isBooleanArray.objects( [ true ] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `objects` method is provided an unsupported number of arguments...
+{
+	isBooleanArray.objects(); // $ExpectError
+	isBooleanArray.objects( [ true ], 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-boolean-array/package.json

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