@stdlib/array-dtypes - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

docs/repl.txt

@@ -9,2 +9,4 @@
     - float64: double-precision floating-point numbers.
+    - complex64: single-precision complex floating-point numbers.
+    - complex128: double-precision complex floating-point numbers.
     - generic: values of any type.
@@ -11,0 +13,0 @@ - int16: signed 16-bit integers.

docs/types/index.d.ts

@@ -21,2 +21,6 @@ /*
 
+/// <reference types="@stdlib/types"/>
+
+import { DataType } from '@stdlib/types/array';
+
 /**
@@ -29,5 +33,5 @@ * Returns a list of array data types.
 * var list = dtypes();
-* // returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]
+* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
 */
-declare function dtypes(): Array<string>;
+declare function dtypes(): Array<DataType>;
 
@@ -34,0 +38,0 @@

docs/types/test.ts

@@ -21,7 +21,8 @@ /*
 
+
 // TESTS //
 
-// The function returns a string array..
+// The function returns an array of data types...
 {
-	dtypes(); // $ExpectType string[]
+	dtypes(); // $ExpectType DataType[]
 }
@@ -28,0 +29,0 @@

lib/dtypes.json

@@ -11,3 +11,5 @@ [
 	"uint8",
-	"uint8c"
+	"uint8c",
+  "complex64",
+  "complex128"
 ]

lib/index.js

@@ -30,3 +30,3 @@ /**
 * var list = dtypes();
-* // returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]
+* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex128', 'complex64' ]
 */
@@ -33,0 +33,0 @@

lib/main.js

@@ -35,3 +35,3 @@ /**
 * var list = dtypes();
-* // returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]
+* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
 */
@@ -38,0 +38,0 @@ function dtypes() {

NOTICE

@@ -1,1 +0,1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

package.json

 {
   "name": "@stdlib/array-dtypes",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "List of array data types.",
@@ -39,3 +39,5 @@ "license": "Apache-2.0",
   },
-  "dependencies": {},
+  "dependencies": {
+    "@stdlib/types": "^0.0.x"
+  },
   "devDependencies": {
@@ -42,0 +44,0 @@ "@stdlib/assert-is-string-array": "^0.0.x",

README.md

@@ -23,3 +23,3 @@ <!--
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
@@ -62,3 +62,3 @@ > List of array data types.
 var out = dtypes();
-// returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]
+// e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
 ```
@@ -70,2 +70,4 @@
 -   `float64`: double-precision floating-point numbers.
+-   `complex64`: single-precision complex floating-point numbers.
+-   `complex128`: double-precision complex floating-point numbers.
 -   `generic`: values of any type.
@@ -139,2 +141,17 @@ -   `int16`: signed 16-bit integers.
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/typed-dtypes`][@stdlib/array/typed-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
+-   <span class="package-name">[`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -166,3 +183,3 @@
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
@@ -186,5 +203,16 @@ </section>
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/array-dtypes.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/array-dtypes/main
 
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/array-dtypes/tree/deno
+[umd-url]: https://github.com/stdlib-js/array-dtypes/tree/umd
+[esm-url]: https://github.com/stdlib-js/array-dtypes/tree/esm
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
@@ -199,4 +227,12 @@ [chat-url]: https://gitter.im/stdlib-js/stdlib/
 
+<!-- <related-links> -->
+
+[@stdlib/array/typed-dtypes]: https://www.npmjs.com/package/@stdlib/array-typed-dtypes
+
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

No alert changes

Improved metrics

Total package byte prevSize

37165

4.76%

Lines of code

142

2.9%

Number of lines in readme file

232

18.37%

Worsened metrics

Dependency count

1

Infinity%

Dependency changes

• + Added

  @stdlib/types@^0.0.x

• + Added

  @stdlib/types@0.0.14
  (transitive)