@stdlib/array-empty-like 0.2.1 → 0.3.0

package/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2023 The Stdlib Authors.
+Copyright (c) 2024 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.
@@ -65,7 +65,7 @@ var emptyLike = require( '@stdlib/array-empty-like' );
 
 #### emptyLike( x\[, dtype] )
 
-Creates an uninitialized array having the same length and data type as a provided array `x`.
+Creates an uninitialized array having the same length and [data type][@stdlib/array/dtypes] as a provided array `x`.
 
 ```javascript
 var x = [ 1, 2, 3, 4, 5 ];
@@ -74,22 +74,7 @@ var arr = emptyLike( x );
 // returns [ 0, 0, 0, 0, 0 ];
 ```
 
-The function recognizes the following data types:
-
--   `float64`: double-precision floating-point numbers (IEEE 754)
--   `float32`: single-precision floating-point numbers (IEEE 754)
--   `complex128`: double-precision complex floating-point numbers
--   `complex64`: single-precision complex floating-point numbers
--   `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
-
-By default, the output array data type is inferred from the provided array `x`. To return an array having a different data type, provide a `dtype` argument.
+By default, the output array [data type][@stdlib/array/dtypes] is inferred from the provided array `x`. To return an array having a different [data type][@stdlib/array/dtypes], provide a `dtype` argument.
 
 ```javascript
 var x = [ 1, 1 ];
@@ -213,8 +198,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-empty-like.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-empty-like
 
-[test-image]: https://github.com/stdlib-js/array-empty-like/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/array-empty-like/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/array-empty-like/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/array-empty-like/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-empty-like/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-empty-like?branch=main
@@ -246,6 +231,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-empty-like/main/LICENSE
 
+[@stdlib/array/dtypes]: https://www.npmjs.com/package/@stdlib/array-dtypes
+
 <!-- <related-links> -->
 
 [@stdlib/array/empty]: https://www.npmjs.com/package/@stdlib/array-empty

package/docs/types/index.d.ts

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { AnyArray, DataTypeMap, TypedArray, ComplexTypedArray } from '@stdlib/types/array';
+import { AnyArray, DataTypeMap, TypedArray, BooleanTypedArray, ComplexTypedArray } from '@stdlib/types/array';
 
 /**
 * Creates an uninitialized array having the same length and data type as a provided input array.
@@ -64,7 +64,7 @@ declare function emptyLike( x: Array<any> ): Array<number>;
 * var arr = emptyLike( x, 'float32' );
 * // returns <Float32Array>
 */
-declare function emptyLike<T extends TypedArray | ComplexTypedArray>( x: T ): T;
+declare function emptyLike<T extends TypedArray | ComplexTypedArray | BooleanTypedArray>( x: T ): T;
 
 /**
 * Creates an uninitialized array having the same length as a provided input array.
@@ -75,21 +75,6 @@ declare function emptyLike<T extends TypedArray | ComplexTypedArray>( x: T ): T;
 * -   If `dtype` is `'generic'`, the function always returns a zero-filled array.
 * -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
 *
-* The function recognizes the following data types:
-*
-* -   `float64`: double-precision floating-point numbers (IEEE 754)
-* -   `float32`: single-precision floating-point numbers (IEEE 754)
-* -   `complex128`: double-precision complex floating-point numbers
-* -   `complex64`: single-precision complex floating-point numbers
-* -   `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 x - input array from which to derive the output array length
 * @param dtype - data type
 * @returns empty array

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-empty-like",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Create an uninitialized array having the same length and data type as a provided array.",
   "license": "Apache-2.0",
   "author": {
@@ -32,8 +32,8 @@
   "dependencies": {
     "@stdlib/array-dtype": "^0.2.1",
     "@stdlib/array-empty": "^0.2.1",
-    "@stdlib/string-format": "^0.2.1",
-    "@stdlib/error-tools-fmtprodmsg": "^0.2.1"
+    "@stdlib/string-format": "^0.2.2",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {
@@ -75,6 +75,7 @@
     "uint8clampedarray",
     "complex128array",
     "complex64array",
+    "booleanarray",
     "complex128",
     "complex64",
     "complex",
@@ -101,6 +102,7 @@
     "clamped",
     "short",
     "long",
+    "bool",
     "generic",
     "empty",
     "empty-like"