Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/utils/properties-in/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 an array of an object's own and inherited property names and symbols.
+*
+* ## Notes
+*
+* -   If provided `null` or `undefined`, the function returns an empty array.
+*
+* @param value - input object
+* @returns a list of own and inherited property names and symbols
+*
+* @example
+* var props = propertiesIn( [] );
+* // returns [...]
+*/
+declare function propertiesIn( value: any ): Array<string|symbol>;
+
+
+// EXPORTS //
+
+export = propertiesIn;

lib/node_modules/@stdlib/utils/properties-in/docs/types/test.ts

@@ -0,0 +1,33 @@
+/*
+* @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 propertiesIn = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings or symbols...
+{
+	propertiesIn( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType (string | symbol)[]
+}
+
+// The compiler throws an error if the function is provided an incorrect number of arguments...
+{
+	propertiesIn(); // $ExpectError
+	propertiesIn( [], 2 ); // $ExpectError
+}

lib/node_modules/@stdlib/utils/properties-in/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/utils/properties/docs/types/index.d.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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Returns an array of an object's own enumerable and non-enumerable property names and symbols.
+*
+* ## Notes
+*
+* -   Property order is not guaranteed, as object property enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's properties, thus allowing for deterministic extraction.
+* -   If provided `null` or `undefined`, the function returns an empty array.
+*
+* @param value - input object
+* @returns a list of own property names and symbols
+*
+* @example
+* var obj = {
+*     'beep': 'boop',
+*     'foo': 3.14
+* };
+*
+* var props = properties( obj );
+* // e.g., returns [ 'beep', 'foo' ]
+*/
+declare function properties( value: any ): Array<string|symbol>;
+
+
+// EXPORTS //
+
+export = properties;

lib/node_modules/@stdlib/utils/properties/docs/types/test.ts

@@ -0,0 +1,33 @@
+/*
+* @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 properties = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings or symbols...
+{
+	properties( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType (string | symbol)[]
+}
+
+// The compiler throws an error if the function is provided an incorrect number of arguments...
+{
+	properties(); // $ExpectError
+	properties( [], 2 ); // $ExpectError
+}

lib/node_modules/@stdlib/utils/properties/package.json

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