@stdlib/ndarray-safe-casts 0.0.4 → 0.0.8

package/NOTICE

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

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # Safe Casts
 
-[![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] -->
 
 > Return a list of ndarray [data types][@stdlib/ndarray/dtypes] to which a provided ndarray [data type][@stdlib/ndarray/dtypes] can be safely cast.
 
@@ -131,6 +131,22 @@ for ( i = 0; i < DTYPES.length; i++ ) {
 
 <!-- /.references -->
 
+<!-- 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/ndarray/casting-modes`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</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>
+-   <span class="package-name">[`@stdlib/ndarray/same-kind-casts`][@stdlib/ndarray/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same kind.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -144,6 +160,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
 
 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
 
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
 ---
 
 ## License
@@ -153,7 +173,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -172,16 +192,38 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-safe-casts/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-safe-casts?branch=main
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-safe-casts
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-safe-casts.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/ndarray-safe-casts/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/ndarray-safe-casts/tree/deno
+[umd-url]: https://github.com/stdlib-js/ndarray-safe-casts/tree/umd
+[esm-url]: https://github.com/stdlib-js/ndarray-safe-casts/tree/esm
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://gitter.im/stdlib-js/stdlib/
+
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-safe-casts/main/LICENSE
 
-[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes
+<!-- <related-links> -->
+
+[@stdlib/ndarray/casting-modes]: https://www.npmjs.com/package/@stdlib/ndarray-casting-modes
+
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
+
+[@stdlib/ndarray/same-kind-casts]: https://www.npmjs.com/package/@stdlib/ndarray-same-kind-casts
+
+<!-- </related-links> -->
 
 </section>
 

package/docs/repl.txt

@@ -9,8 +9,8 @@
 
     Parameters
     ----------
-    dtype: string (optional)
-        ndarray data type.
+    dtype: any (optional)
+        ndarray data type value.
 
     Returns
     -------

package/docs/types/index.d.ts

@@ -26,14 +26,14 @@
 * -   If not provided an ndarray data type, the function returns a casting table.
 * -   If provided an unrecognized ndarray data type, the function returns `null`.
 *
-* @param dtype - ndarray data type
+* @param dtype - ndarray data type value
 * @returns list of ndarray data types or null
 *
 * @example
 * var list = safeCasts( 'float32' );
 * // returns [...]
 */
-declare function safeCasts( dtype?: string ): any;
+declare function safeCasts( dtype?: any ): any;
 
 
 // EXPORTS //

package/docs/types/test.ts

@@ -28,16 +28,6 @@ import safeCasts = require( './index' );
 	safeCasts( 'float' ); // $ExpectType any
 }
 
-// The function does not compile if provided a value other than a string...
-{
-	safeCasts( 123 ); // $ExpectError
-	safeCasts( true ); // $ExpectError
-	safeCasts( false ); // $ExpectError
-	safeCasts( null ); // $ExpectError
-	safeCasts( {} ); // $ExpectError
-	safeCasts( ( x: number ): number => x ); // $ExpectError
-}
-
 // The function does not compile if provided more than one argument...
 {
 	safeCasts( 'float32', 123 ); // $ExpectError

package/lib/main.js

@@ -22,6 +22,7 @@
 
 var objectKeys = require( '@stdlib/utils-keys' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
+var resolve = require( '@stdlib/ndarray-base-dtype-resolve-str' );
 var SAFE_CASTS = require( './safe_casts.json' );
 
 
@@ -106,7 +107,7 @@ function generateTable() {
 /**
 * Returns a list of ndarray data types to which a provided ndarray data type can be safely cast.
 *
-* @param {string} [dtype] - ndarray data type
+* @param {*} [dtype] - ndarray data type value
 * @returns {(Object|StringArray|null)} list of ndarray data types or null
 *
 * @example
@@ -121,6 +122,7 @@ function safeCasts( dtype ) {
 		// Lazily generate table...
 		TABLE = generateTable();
 	}
+	dtype = resolve( dtype );
 	if ( hasOwnProp( TABLE, dtype ) ) {
 		return TABLE[ dtype ].slice();
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-safe-casts",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "Return a list of ndarray data types to which a provided ndarray data type can be safely cast.",
   "license": "Apache-2.0",
   "author": {
@@ -18,6 +18,7 @@
     "benchmark": "./benchmark",
     "doc": "./docs",
     "example": "./examples",
+    "include": "./include",
     "lib": "./lib",
     "test": "./test"
   },
@@ -28,7 +29,7 @@
     "examples": "make examples",
     "benchmark": "make benchmark"
   },
-  "homepage": "https://github.com/stdlib-js/stdlib",
+  "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
     "url": "git://github.com/stdlib-js/ndarray-safe-casts.git"
@@ -38,6 +39,7 @@
   },
   "dependencies": {
     "@stdlib/assert-has-own-property": "^0.0.x",
+    "@stdlib/ndarray-base-dtype-resolve-str": "^0.0.x",
     "@stdlib/ndarray-dtypes": "^0.0.x",
     "@stdlib/utils-keys": "^0.0.x",
     "@stdlib/utils-library-manifest": "^0.0.x"

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/ndarray-safe-casts/releases) for the changelog.