Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/assert/is-boxed-primitive/docs/types/index.d.ts

@@ -0,0 +1,58 @@
+/*
+* @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 JavaScript boxed primitive.
+*
+* @param value - value to test
+* @returns boolean indicating if a value is a JavaScript boxed primitive
+*
+* @example
+* var bool = isBoxedPrimitive( new String( 'beep' ) );
+* // returns true
+*
+* @example
+* var bool = isBoxedPrimitive( new Number( 3.21 ) );
+* // returns true
+*
+* @example
+* var Symbol = require( '@stdlib/symbol/ctor' );
+* var bool = isBoxedPrimitive( Object( Symbol( 'beep' ) ) );
+* // returns true
+*
+* @example
+* var bool = isBoxedPrimitive( true );
+* // returns false
+*
+* @example
+* var bool = isBoxedPrimitive( {} );
+* // returns false
+*
+* @example
+* var Symbol = require( '@stdlib/symbol/ctor' );
+* var bool = isBoxedPrimitive( Symbol( 'beep' ) );
+* // returns false
+*/
+declare function isBoxedPrimitive( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isBoxedPrimitive;

lib/node_modules/@stdlib/assert/is-boxed-primitive/docs/types/test.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.
+*/
+
+import isBoxedPrimitive = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	// tslint:disable-next-line:no-construct
+	isBoxedPrimitive( new String( 'beep' ) ); // $ExpectType boolean
+	isBoxedPrimitive( 'beep' ); // $ExpectType boolean
+	isBoxedPrimitive( [] ); // $ExpectType boolean
+
+	// tslint:disable-next-line:no-construct
+	isBoxedPrimitive( new Number( 3.21 ) ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isBoxedPrimitive(); // $ExpectError
+
+	// tslint:disable-next-line:no-construct
+	isBoxedPrimitive( new String( 'beep' ), 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-boxed-primitive/lib/main.js

@@ -59,7 +59,6 @@ var isSymbol = require( '@stdlib/assert/is-symbol' ).isObject;
 * var Symbol = require( '@stdlib/symbol/ctor' );
 * var bool = isBoxedPrimitive( Symbol( 'beep' ) );
 * // returns false
-*
 */
 function isBoxedPrimitive( value ) {
 	if ( typeof value !== 'object' ) {

lib/node_modules/@stdlib/assert/is-boxed-primitive/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-node-builtin/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 whether a string matches a Node.js built-in module name.
+*
+* @param x - value to test
+* @returns boolean indicating whether a string matches a Node.js built-in module name
+*
+* @example
+* var out = isNodeBuiltin( 'cluster' );
+* // returns true
+*
+* @example
+* var out = isNodeBuiltin( 'crypto' );
+* // returns true
+*
+* @example
+* var out = isNodeBuiltin( 'fs-extra' );
+* // returns false
+*
+* @example
+* var out = isNodeBuiltin( '' );
+* // returns false
+*/
+declare function isNodeBuiltin( x: any ): boolean;
+
+
+// EXPORTS //
+
+export = isNodeBuiltin;

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

@@ -0,0 +1,35 @@
+/*
+* @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 isNodeBuiltin = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isNodeBuiltin( 'cluster' ); // $ExpectType boolean
+	isNodeBuiltin( 'fs-extra' ); // $ExpectType boolean
+	isNodeBuiltin( null ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isNodeBuiltin(); // $ExpectError
+	isNodeBuiltin( null, 123 ); // $ExpectError
+}

lib/node_modules/@stdlib/assert/is-node-builtin/package.json

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