Add Typescript definitions

Author: Planeshifter

lib/node_modules/@stdlib/buffer/from-array/docs/types/index.d.ts

@@ -0,0 +1,44 @@
+/*
+* @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="node"/>
+/// <reference types="@stdlib/types"/>
+
+import { Buffer } from 'buffer';
+import { Collection } from '@stdlib/types/object';
+
+/**
+* Allocates a buffer using an octet array.
+*
+* @param arr - octet array
+* @returns new `Buffer` instance
+*
+* @example
+* var fromArray = require( `@stdlib/buffer/from-array` );
+*
+* var buf = fromArray( [ 1, 2, 3, 4 ] );
+* // returns <Buffer>
+*/
+declare function fromArray( arr: Collection ): Buffer;
+
+
+// EXPORTS //
+
+export = fromArray;

lib/node_modules/@stdlib/buffer/from-array/docs/types/test.ts

@@ -0,0 +1,42 @@
+/*
+* @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 fromArray = require( './index' );
+
+
+// TESTS //
+
+// The function returns a buffer...
+{
+	fromArray( [ 1, 2, 3, 4 ] ); // $ExpectType Buffer
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a collection...
+{
+	fromArray( 123 ); // $ExpectError
+	fromArray( false ); // $ExpectError
+	fromArray( true ); // $ExpectError
+	fromArray( null ); // $ExpectError
+	fromArray( {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	fromArray(); // $ExpectError
+	fromArray( [ 1, 2, 3, 4 ], 4 ); // $ExpectError
+}

lib/node_modules/@stdlib/buffer/from-array/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/buffer/from-arraybuffer/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="node"/>
+
+import { Buffer } from 'buffer';
+
+/**
+* Allocates a buffer from an `ArrayBuffer`.
+*
+* ## Notes
+*
+* The behavior of this function varies across Node.js versions due to changes in the underlying Node.js APIs:
+*
+* -   `<6.0.0`: if provided an empty ArrayBuffer, the function returns an empty Buffer which is **not** an ArrayBuffer view.
+* -   otherwise, the function returns a view of an ArrayBuffer without copying the underlying memory.
+*
+*
+* @param buf - ArrayBuffer instance
+* @param byteOffset - index specifying the location of the first buffer byte (default: 0)
+* @param length - number of buffer bytes (default: buf.byteLength)
+* @throws second argument must be a nonnegative integer
+* @throws second argument must not exceed number of bytes in input ArrayBuffer
+* @throws last argument must be a nonnegative integer
+* @throws last argument must not exceed number of bytes in input ArrayBuffer
+* @returns new `Buffer` instance
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+* var ab = new ArrayBuffer( 10 );
+*
+* var buf = fromArrayBuffer( ab );
+* // returns <Buffer>
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+* var ab = new ArrayBuffer( 10 );
+*
+* var buf = fromArrayBuffer( ab, 2, 4 );
+* // returns <Buffer>
+*/
+declare function fromArrayBuffer( buf: ArrayBuffer,  byteOffset?: number, length?: number ): Buffer; // tslint-disable-line max-line-length
+
+
+// EXPORTS //
+
+export = fromArrayBuffer;

lib/node_modules/@stdlib/buffer/from-arraybuffer/docs/types/test.ts

@@ -0,0 +1,72 @@
+/*
+* @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 fromArrayBuffer = require( './index' );
+
+
+// TESTS //
+
+// The function returns a buffer...
+{
+	const buf = new ArrayBuffer( 10 );
+	fromArrayBuffer( buf ); // $ExpectType Buffer
+	fromArrayBuffer( buf, 2 ); // $ExpectType Buffer
+	fromArrayBuffer( buf, 2, 4 ); // $ExpectType Buffer
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array buffer...
+{
+	fromArrayBuffer( 'abc' ); // $ExpectError
+	fromArrayBuffer( 123 ); // $ExpectError
+	fromArrayBuffer( false ); // $ExpectError
+	fromArrayBuffer( true ); // $ExpectError
+	fromArrayBuffer( null ); // $ExpectError
+	fromArrayBuffer( {} ); // $ExpectError
+	fromArrayBuffer( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a number...
+{
+	const buf = new ArrayBuffer( 10 );
+	fromArrayBuffer( buf, 'abc' ); // $ExpectError
+	fromArrayBuffer( buf, false ); // $ExpectError
+	fromArrayBuffer( buf, true ); // $ExpectError
+	fromArrayBuffer( buf, null ); // $ExpectError
+	fromArrayBuffer( buf, [] ); // $ExpectError
+	fromArrayBuffer( buf, {} ); // $ExpectError
+	fromArrayBuffer( buf, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a third argument which is not a number...
+{
+	const buf = new ArrayBuffer( 10 );
+	fromArrayBuffer( buf, 2, 'abc' ); // $ExpectError
+	fromArrayBuffer( buf, 2, false ); // $ExpectError
+	fromArrayBuffer( buf, 2, true ); // $ExpectError
+	fromArrayBuffer( buf, 2, null ); // $ExpectError
+	fromArrayBuffer( buf, 2, [] ); // $ExpectError
+	fromArrayBuffer( buf, 2, {} ); // $ExpectError
+	fromArrayBuffer( buf, 2, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	const buf = new ArrayBuffer( 10 );
+	fromArrayBuffer(); // $ExpectError
+	fromArrayBuffer( buf, 2, 4, 2 ); // $ExpectError
+}

lib/node_modules/@stdlib/buffer/from-arraybuffer/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/buffer/from-buffer/docs/types/index.d.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.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="node"/>
+
+import { Buffer } from 'buffer';
+
+/**
+* Copies buffer data to a new `Buffer` instance.
+*
+* @param buffer - buffer from which to copy
+* @returns new `Buffer` instance
+*
+* @example
+* var fromArray = require( `@stdlib/buffer/from-array` );
+*
+* var b1 = fromArray( [ 1, 2, 3, 4 ] );
+* // returns <Buffer>
+*
+* var b2 = fromBuffer( b1 );
+* // returns <Buffer>
+*/
+declare function fromBuffer( buffer: Buffer ): Buffer;
+
+
+// EXPORTS //
+
+export = fromBuffer;

lib/node_modules/@stdlib/buffer/from-buffer/docs/types/test.ts

@@ -0,0 +1,47 @@
+/*
+* @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 fromArray = require( '@stdlib/buffer/from-array' );
+import fromBuffer = require( './index' );
+
+// TESTS //
+
+// The function returns a buffer...
+{
+	const buf = fromArray( [ 1, 2, 3, 4 ] );
+	fromBuffer( buf ); // $ExpectType Buffer
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a buffer...
+{
+	fromBuffer( 'abc' ); // $ExpectError
+	fromBuffer( 123 ); // $ExpectError
+	fromBuffer( false ); // $ExpectError
+	fromBuffer( true ); // $ExpectError
+	fromBuffer( null ); // $ExpectError
+	fromBuffer( {} ); // $ExpectError
+	fromBuffer( [] ); // $ExpectError
+	fromBuffer( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	const buf = fromArray( [ 1, 2, 3, 4 ] );
+	fromBuffer(); // $ExpectError
+	fromBuffer( buf, 4 ); // $ExpectError
+}

lib/node_modules/@stdlib/buffer/from-buffer/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/buffer/from-string/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @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="node"/>
+
+import { Buffer } from 'buffer';
+
+/**
+* Allocates a buffer containing a provided string.
+*
+* @param str - input string
+* @param encoding - character encoding (default: 'utf8')
+* @throws second argument must be a valid encoding
+* @returns new `Buffer` instance
+*
+* @example
+* var buf = fromString( 'beep boop' );
+* // returns <Buffer>
+*/
+declare function fromString( str: string, encoding?: string ): Buffer;
+
+
+// EXPORTS //
+
+export = fromString;