Add Typescript definition

Planeshifter · Planeshifter · commit 6fc29f814cb7 · 2019-03-04T10:43:23.000-05:00
diff --git a/lib/node_modules/@stdlib/assert/is-arguments/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arguments/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 whether a value is an `arguments` object.
+*
+* @param value - value to test
+* @returns boolean indicating whether a value is an `arguments` object
+*
+* @example
+* function foo() {
+*     return arguments;
+* }
+*
+* var bool = isArguments( foo() );
+* // returns true
+*
+* @example
+* var bool = isArguments( [] );
+* // returns false
+*/
+declare function isArguments( value: any ): boolean;
+
+
+// EXPORTS //
+
+export = isArguments;
diff --git a/lib/node_modules/@stdlib/assert/is-arguments/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-arguments/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 isArguments = require( './index' );
+
+
+// FUNCTIONS //
+
+/**
+* Returns the `arguments` object of the function.
+*
+* @returns arguments
+*/
+function foo(): any {
+	return arguments;
+}
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isArguments( foo() ); // $ExpectType boolean
+	isArguments( [] ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isArguments(); // $ExpectError
+	isArguments( foo(), 123 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/assert/is-arguments/package.json b/lib/node_modules/@stdlib/assert/is-arguments/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
