Add Typescript definition

Planeshifter · Planeshifter · commit 815c1336e448 · 2021-04-13T21:25:06.000-04:00
diff --git a/lib/node_modules/@stdlib/array/reviver/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/reviver/docs/types/index.d.ts
@@ -0,0 +1,41 @@
+/*
+* @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
+
+/**
+* Revives a JSON-serialized typed array.
+*
+* @param key - key
+* @param value - value
+* @returns value or typed array
+*
+* @example
+* var parseJSON = require( `@stdlib/utils/parse-json` );
+*
+* var str = '{"type":"Float64Array","data":[5,3]}';
+*
+* var arr = parseJSON( str, reviver );
+* // returns <Float64Array>[ 5.0, 3.0 ]
+*/
+declare function reviver( key: string, value: any ): any;
+
+
+// EXPORTS //
+
+export = reviver;
diff --git a/lib/node_modules/@stdlib/array/reviver/docs/types/test.ts b/lib/node_modules/@stdlib/array/reviver/docs/types/test.ts
@@ -0,0 +1,45 @@
+/*
+* @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.
+*/
+
+import reviver = require( './index' );
+
+
+// TESTS //
+
+// The function can be used to revive a serialized object...
+{
+	JSON.parse( '{"type":"Float64Array","data":[5,3]}', reviver ); // $ExpectType any
+}
+
+// The function does not compile if provided a first argument that is not a string...
+{
+	reviver( true, 1 ); // $ExpectError
+	reviver( false, 1 ); // $ExpectError
+	reviver( null, 1 ); // $ExpectError
+	reviver( undefined, 1 ); // $ExpectError
+	reviver( 5, 1 ); // $ExpectError
+	reviver( [], 1 ); // $ExpectError
+	reviver( {}, 1 ); // $ExpectError
+	reviver( ( x: number ): number => x, 1 ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	reviver(); // $ExpectError
+	reviver( 'beep' ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/array/reviver/package.json b/lib/node_modules/@stdlib/array/reviver/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
