Add TypeScript declarations

Author: kgryte

lib/node_modules/@stdlib/array/filled/README.md

@@ -83,10 +83,17 @@ var arr2 = filledarray( 1, 5, 'uint8' );
 
 #### filledarray( value, array\[, dtype] )
 
-Creates a filled array from another array.
+Creates a filled array from another array (or array-like object).
 
 ```javascript
-var arr1 = filledarray( 1.0, [ 5.0, -3.0, 2.0 ] );
+var arr0 = {
+    '0': 0.5,
+    '1': 0.5,
+    '2': 0.5,
+    'length': 3
+};
+
+var arr1 = filledarray( 1.0, arr0 );
 // returns <Float64Array>[ 1.0, 1.0, 1.0 ]
 
 var arr2 = filledarray( 2.0, arr1 );
@@ -96,15 +103,20 @@ var arr3 = filledarray( 3, arr1, 'int32' );
 // returns <Int32Array>[ 3, 3, 3 ]
 ```
 
-#### filledarray( value, obj\[, dtype] )
+#### filledarray( value, iterable\[, dtype] )
 
-Creates a filled array from an array-like `object` or iterable.
+Creates a filled array from an iterable.
 
 ```javascript
-var arr1 = filledarray( 1.0, [ 0.5, 0.5, 0.5 ] );
+var iterConstant = require( '@stdlib/iter/constant' );
+
+var it = iterConstant( 3.0, {
+    'iter': 3
+});
+var arr1 = filledarray( 1.0, it );
 // returns <Float64Array>[ 1.0, 1.0, 1.0 ]
 
-var arr2 = filledarray( 1.0, [ 0.5, 0.5, 0.5 ], 'float32' );
+var arr2 = filledarray( 1.0, it, 'float32' );
 // returns <Float32Array>[ 1.0, 1.0, 1.0 ]
 ```
 

lib/node_modules/@stdlib/array/filled/docs/repl.txt

@@ -1,5 +1,5 @@
 
-{{alias}}( value, [dtype] )
+{{alias}}( value[, dtype] )
     Creates a filled array.
 
     The function supports the following data types:
@@ -66,14 +66,14 @@
 
 
 {{alias}}( value, array[, dtype] )
-    Creates a filled array from another array.
+    Creates a filled array from another array (or array-like object).
 
     Parameters
     ----------
     value: any
         Fill value.
 
-    array: TypedArray|Array
+    array: ArrayLikeObject
         Array from which to generate another array.
 
     dtype: string (optional)
@@ -92,16 +92,16 @@
     <Float32Array>[ 1.0, 1.0, 1.0 ]
 
 
-{{alias}}( value, obj[, dtype] )
-    Creates a filled array from an array-like object or iterable.
+{{alias}}( value, iterable[, dtype] )
+    Creates a filled array from an iterable.
 
     Parameters
     ----------
     value: any
         Fill value.
 
-    obj: Object
-        Array-like object or iterable from which to generate an array.
+    iterable: Object
+        Iterable from which to generate an array.
 
     dtype: string (optional)
         Data type. Default: 'float64'.
@@ -113,7 +113,7 @@
 
     Examples
     --------
-    > var arr1 = [ 0.5, 0.5, 0.5 ];
+    > var arr1 = {{alias:@stdlib/iter/constant}}( 3.0, {'iter': 3} );
     > var arr2 = {{alias}}( 1.0, arr1, 'float32' )
     <Float32Array>[ 1.0, 1.0, 1.0 ]
 

lib/node_modules/@stdlib/array/filled/docs/types/index.d.ts

@@ -0,0 +1,226 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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';
+import { Collection } from '@stdlib/types/object';
+import { IterableIterator } from '@stdlib/types/iter';
+
+/**
+* Array or typed array.
+*/
+type ArrayOrTypedArray = Array<any> | TypedArray;
+
+/**
+* Creates a filled array.
+*
+* The function recognizes the following data types:
+*
+* -   `float64`: double-precision floating-point numbers (IEEE 754)
+* -   `float32`: single-precision floating-point numbers (IEEE 754)
+* -   `int32`: 32-bit two's complement signed integers
+* -   `uint32`: 32-bit unsigned integers
+* -   `int16`: 16-bit two's complement signed integers
+* -   `uint16`: 16-bit unsigned integers
+* -   `int8`: 8-bit two's complement signed integers
+* -   `uint8`: 8-bit unsigned integers
+* -   `uint8c`: 8-bit unsigned integers clamped to `0-255`
+* -   `generic`: generic JavaScript values
+*
+* @param value - fill value
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var arr = filledarray( 1.0 );
+* // returns <Float64Array>
+*
+* @example
+* var arr = filledarray( 1.0, 'float32' );
+* // returns <Float32Array>
+*/
+declare function filledarray( value: any, dtype?: string ): ArrayOrTypedArray;
+
+/**
+* Creates a filled array having a specified `length`.
+*
+* @param value - fill value
+* @param length - array length
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var arr = filledarray( 1.0, 5 );
+* // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]
+*
+* @example
+* var arr = filledarray( 1.0, 5, 'float32' );
+* // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]
+*/
+declare function filledarray( value: any, length: number, dtype?: string ): ArrayOrTypedArray; // tslint:disable-line:max-line-length
+
+/**
+* Creates a filled array from another `array`.
+*
+* @param value - fill value
+* @param array - typed array or array-like object
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var arr = filledarray( 1.0, [ 5.0, -3.0, 2.0 ] );
+* // returns <Float64Array>[ 1.0, 1.0, 1.0 ]
+*
+* @example
+* var arr = filledarray( 1.0, [ 5.0, -3.0, 2.0 ], 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0 ]
+*/
+declare function filledarray( value: any, array: Collection, dtype?: string ): ArrayOrTypedArray; // tslint:disable-line:max-line-length unified-signatures
+
+/**
+* Creates a filled array from an iterable.
+*
+* @param value - fill value
+* @param iterable - iterable
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var iterConstant = require( `@stdlib/iter/constant` );
+*
+* var it = iterConstant( 3.0, {
+*     'iter': 3
+* });
+* var arr = filledarray( 1.0, it );
+* // returns <Float64Array>[ 1.0, 1.0, 1.0 ]
+*
+* @example
+* var iterConstant = require( `@stdlib/iter/constant` );
+*
+* var it = iterConstant( 3.0, {
+*     'iter': 3
+* });
+* var arr = filledarray( 1.0, it, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0 ]
+*/
+declare function filledarray( value: any, iterable: IterableIterator, dtype?: string ): ArrayOrTypedArray; // tslint:disable-line:max-line-length unified-signatures
+
+/**
+* Returns a filled typed array view of an `ArrayBuffer`.
+*
+* ## Notes
+*
+* -   Creating a generic array from an `ArrayBuffer` is **not** supported.
+*
+* @param value - fill value
+* @param buffer - `ArrayBuffer`
+* @param byteOffset - byte offset
+* @param length - view length
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf, 8, 2 );
+* // returns <Float64Array>[ 1.0, 1.0 ]
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf, 8, 2, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0 ]
+*
+*/
+declare function filledarray( value: any, buffer: ArrayBuffer, byteOffset: number, length: number, dtype?: string ): TypedArray; // tslint:disable-line:max-line-length
+
+/**
+* Returns a filled typed array view of an `ArrayBuffer`.
+*
+* ## Notes
+*
+* -   Creating a generic array from an `ArrayBuffer` is **not** supported.
+*
+* @param value - fill value
+* @param buffer - `ArrayBuffer`
+* @param byteOffset - byte offset
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf, 8 );
+* // returns <Float64Array>[ 1.0, 1.0, 1.0 ]
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf, 8, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
+*
+*/
+declare function filledarray( value: any, buffer: ArrayBuffer, byteOffset: number, dtype?: string ): TypedArray; // tslint:disable-line:max-line-length
+
+/**
+* Returns a filled typed array view of an `ArrayBuffer`.
+*
+* ## Notes
+*
+* -   Creating a generic array from an `ArrayBuffer` is **not** supported.
+*
+* @param value - fill value
+* @param buffer - `ArrayBuffer`
+* @param dtype - data type (default: 'float64')
+* @throws must provide a recognized data type
+* @returns filled array
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf );
+* // returns <Float64Array>[ 1.0, 1.0, 1.0, 1.0 ]
+*
+* @example
+* var ArrayBuffer = require( `@stdlib/array/buffer` );
+*
+* var buf = new ArrayBuffer( 32 );
+* var arr = filledarray( 1.0, buf, 'float32' );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
+*
+*/
+declare function filledarray( value: any, buffer: ArrayBuffer, dtype?: string ): TypedArray; // tslint:disable-line:max-line-length unified-signatures
+
+
+// EXPORTS //
+
+export = filledarray;