Add Typescript definition

Author: Planeshifter

lib/node_modules/@stdlib/array/to-json/docs/types/index.d.ts

@@ -0,0 +1,64 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { TypedArray } from '@stdlib/types/array';
+
+/**
+* JSON representation of typed array.
+*/
+interface JSONRepresentation {
+	/**
+	* Typed array type.
+	*/
+	type: 'Float64Array' | 'Float32Array' | 'Int32Array' | 'Uint32Array' | 'Int16Array' | 'Uint16Array' | 'Int8Array' | 'Uint8Array' | 'Uint8ClampedArray'; // tslint:disable-line:max-line-length
+
+	/**
+	* Typed array data as a generic array.
+	*/
+	data: Array<number>;
+}
+
+/**
+* Returns a JSON representation of a typed array.
+*
+* ## Notes
+*
+* -   We build a JSON object representing a typed array similar to how Node.js `Buffer` objects are represented. See [Buffer][1].
+*
+* [1]: https://nodejs.org/api/buffer.html#buffer_buf_tojson
+*
+* @param arr - typed array to serialize
+* @returns JSON representation
+*
+* @example
+* var Float64Array = require( `@stdlib/array/float64` );
+*
+* var arr = new Float64Array( [ 5.0, 3.0 ] );
+* var json = toJSON( arr );
+* // returns { 'type': 'Float64Array', 'data': [ 5.0, 3.0 ] }
+*/
+declare function toJSON( arr: TypedArray ): JSONRepresentation;
+
+
+// EXPORTS //
+
+export = toJSON;

lib/node_modules/@stdlib/array/to-json/docs/types/test.ts

@@ -0,0 +1,49 @@
+/*
+* @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 toJSON = require( './index' );
+
+
+// TESTS //
+
+// The function returns a JSON representation...
+{
+	const x = new Float64Array( 10 );
+
+	toJSON( x ); // $ExpectType JSONRepresentation
+}
+
+// The compiler throws an error if the function is provided a first argument which is not array-like...
+{
+	toJSON( 'abc' ); // $ExpectError
+	toJSON( 123 );  // $ExpectError
+	toJSON( true ); // $ExpectError
+	toJSON( false ); // $ExpectError
+	toJSON( {} ); // $ExpectError
+	toJSON( [] ); // $ExpectError
+	toJSON( null ); // $ExpectError
+	toJSON( undefined ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = new Float64Array( 10 );
+
+	toJSON(); // $ExpectError
+	toJSON( x, 3 ); // $ExpectError
+}

lib/node_modules/@stdlib/array/to-json/package.json

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