Add Typescript definition

Planeshifter · Planeshifter · commit 8c1aa598efb8 · 2021-04-05T20:26:47.000-04:00
diff --git a/lib/node_modules/@stdlib/symbol/ctor/docs/types/index.d.ts b/lib/node_modules/@stdlib/symbol/ctor/docs/types/index.d.ts
@@ -0,0 +1,34 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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
+
+// EXPORTS //
+
+/**
+* Returns a symbol.
+*
+* ## Notes
+*
+* -   Unlike conventional constructors, this function does **not** support the `new` keyword.
+* -   This function is only supported in environments which support symbols. number primitives.
+*
+* @param description - symbol description which can be used for debugging but not to access the symbol itself.
+* @returns symbol
+*/
+export = Symbol;
diff --git a/lib/node_modules/@stdlib/symbol/ctor/docs/types/test.ts b/lib/node_modules/@stdlib/symbol/ctor/docs/types/test.ts
@@ -0,0 +1,34 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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.
+*/
+
+// tslint:disable: no-unused-expression
+
+import Symbol = require( './index' );
+
+
+// TESTS //
+
+// The function returns a symbol...
+{
+	Symbol( 'boop' ); // $ExpectType symbol
+}
+
+// The function does not compile if provided an unsupported number of arguments...
+{
+	Symbol( 'beep', 'boop' ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/symbol/ctor/package.json b/lib/node_modules/@stdlib/symbol/ctor/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
