Add Typescript definition

Planeshifter · Planeshifter · commit bf9a6e14d218 · 2019-07-30T18:21:03.000-06:00
diff --git a/lib/node_modules/@stdlib/utils/global/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/global/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
+
+/**
+* Returns the global object.
+*
+* ## Notes
+*
+* -   Using code generation is the **most** reliable way to resolve the global object; however, doing so is likely to violate content security policies (CSPs) in, e.g., Chrome Apps and elsewhere.
+*
+* @param codegen - boolean indicating whether to use code generation to resolve the global object
+* @returns global object
+*
+* @example
+* var g = getGlobal();
+* // returns {...}
+*/
+declare function getGlobal( codegen?: boolean ): any;
+
+
+// EXPORTS //
+
+export = getGlobal;
diff --git a/lib/node_modules/@stdlib/utils/global/docs/types/test.ts b/lib/node_modules/@stdlib/utils/global/docs/types/test.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.
+*/
+
+import getGlobal = require( './index' );
+
+
+// TESTS //
+
+// The function returns an object...
+{
+	getGlobal(); // $ExpectType any
+	getGlobal( true ); // $ExpectType any
+	getGlobal( false ); // $ExpectType any
+}
+
+// The compiler throws an error if the function is provided a value other than a boolean...
+{
+	getGlobal( 'abc' ); // $ExpectError
+	getGlobal( 5 ); // $ExpectError
+	getGlobal( [] ); // $ExpectError
+	getGlobal( {} ); // $ExpectError
+	getGlobal( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided more than one argument...
+{
+	getGlobal( true, 2 ); // $ExpectError
+	getGlobal( true, 2, 3 ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/utils/global/package.json b/lib/node_modules/@stdlib/utils/global/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
