@stdlib/ndarray-base-assert-is-data-type 0.2.1 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -65,7 +65,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );
 
 #### isDataType( value )
 
-Tests if an input `value` is a supported ndarray data type.
+Tests if an input value is a supported ndarray data type.
 
 ```javascript
 var bool = isDataType( 'float32' );
@@ -83,6 +83,10 @@ bool = isDataType( 'int32' );
 
 <section class="notes">
 
+## Notes
+
+-   The function returns `true` when provided any supported ndarray [data type][@stdlib/ndarray/dtypes], a [struct][@stdlib/dstructs/struct] constructor describing a fixed-width composite data type, or a [`DataType`][@stdlib/ndarray/dtype-ctor] instance.
+
 </section>
 
 <!-- /.notes -->
@@ -184,7 +188,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -197,8 +201,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-assert-is-data-type.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-assert-is-data-type
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-assert-is-data-type/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/ndarray-base-assert-is-data-type/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/ndarray-base-assert-is-data-type/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/ndarray-base-assert-is-data-type/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-assert-is-data-type/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-assert-is-data-type?branch=main
@@ -210,8 +214,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -230,6 +234,12 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-assert-is-data-type/main/LICENSE
 
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
+
+[@stdlib/ndarray/dtype-ctor]: https://www.npmjs.com/package/@stdlib/ndarray-dtype-ctor
+
+[@stdlib/dstructs/struct]: https://www.npmjs.com/package/@stdlib/dstructs-struct
+
 </section>
 
 <!-- /.links -->

package/dist/index.js

@@ -1,5 +1,5 @@
-"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var t=s(function(v,e){
-var i=require('@stdlib/array-base-assert-contains/dist').factory,u=require('@stdlib/ndarray-dtypes/dist'),c=i(u());e.exports=c
-});var o=t();module.exports=o;
+"use strict";var i=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var a=i(function(y,t){
+var s=require('@stdlib/ndarray-base-assert-is-data-type-string/dist'),u=require('@stdlib/ndarray-base-assert-is-data-type-object/dist'),p=require('@stdlib/ndarray-base-assert-is-struct-data-type/dist');function c(r){return s(r)||u(r)||p(r)}t.exports=c
+});var n=a();module.exports=n;
 /** @license Apache-2.0 */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/main.js", "../lib/index.js"],
-  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar contains = require( '@stdlib/array-base-assert-contains' ).factory;\nvar dtypes = require( '@stdlib/ndarray-dtypes' );\n\n\n// MAIN //\n\n/**\n* Tests whether an input value is a supported ndarray data type.\n*\n* @name isDataType\n* @type {Function}\n* @param {*} v - value to test\n* @returns {boolean} boolean indicating whether an input value is a supported ndarray data type\n*\n* @example\n* var bool = isDataType( 'binary' );\n* // returns true\n*\n* bool = isDataType( 'float32' );\n* // returns true\n*\n* bool = isDataType( 'float64' );\n* // returns true\n*\n* bool = isDataType( 'generic' );\n* // returns true\n*\n* bool = isDataType( 'int16' );\n* // returns true\n*\n* bool = isDataType( 'int32' );\n* // returns true\n*\n* bool = isDataType( 'int8' );\n* // returns true\n*\n* bool = isDataType( 'uint16' );\n* // returns true\n*\n* bool = isDataType( 'uint32' );\n* // returns true\n*\n* bool = isDataType( 'uint8' );\n* // returns true\n*\n* bool = isDataType( 'uint8c' );\n* // returns true\n*\n* bool = isDataType( 'foo' );\n* // returns false\n*/\nvar isDataType = contains( dtypes() );\n\n\n// EXPORTS //\n\nmodule.exports = isDataType;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Test whether an input value is a supported ndarray data type.\n*\n* @module @stdlib/ndarray-base-assert-is-data-type\n*\n* @example\n* var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\n*\n* var bool = isDataType( 'binary' );\n* // returns true\n*\n* bool = isDataType( 'float32' );\n* // returns true\n*\n* bool = isDataType( 'float64' );\n* // returns true\n*\n* bool = isDataType( 'generic' );\n* // returns true\n*\n* bool = isDataType( 'int16' );\n* // returns true\n*\n* bool = isDataType( 'int32' );\n* // returns true\n*\n* bool = isDataType( 'int8' );\n* // returns true\n*\n* bool = isDataType( 'uint16' );\n* // returns true\n*\n* bool = isDataType( 'uint32' );\n* // returns true\n*\n* bool = isDataType( 'uint8' );\n* // returns true\n*\n* bool = isDataType( 'uint8c' );\n* // returns true\n*\n* bool = isDataType( 'foo' );\n* // returns false\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
-  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,oCAAqC,EAAE,QAC3DC,EAAS,QAAS,wBAAyB,EAkD3CC,EAAaF,EAAUC,EAAO,CAAE,EAKpCF,EAAO,QAAUG,ICXjB,IAAIC,EAAO,IAKX,OAAO,QAAUA",
-  "names": ["require_main", "__commonJSMin", "exports", "module", "contains", "dtypes", "isDataType", "main"]
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isDataTypeString = require( '@stdlib/ndarray-base-assert-is-data-type-string' );\nvar isDataTypeObject = require( '@stdlib/ndarray-base-assert-is-data-type-object' );\nvar isStructDataType = require( '@stdlib/ndarray-base-assert-is-struct-data-type' );\n\n\n// MAIN //\n\n/**\n* Tests whether an input value is a supported ndarray data type.\n*\n* @param {*} v - value to test\n* @returns {boolean} boolean indicating whether an input value is a supported ndarray data type\n*\n* @example\n* var bool = isDataType( 'binary' );\n* // returns true\n*\n* bool = isDataType( 'float32' );\n* // returns true\n*\n* bool = isDataType( 'float64' );\n* // returns true\n*\n* bool = isDataType( 'generic' );\n* // returns true\n*\n* bool = isDataType( 'int16' );\n* // returns true\n*\n* bool = isDataType( 'int32' );\n* // returns true\n*\n* bool = isDataType( 'int8' );\n* // returns true\n*\n* bool = isDataType( 'uint16' );\n* // returns true\n*\n* bool = isDataType( 'uint32' );\n* // returns true\n*\n* bool = isDataType( 'uint8' );\n* // returns true\n*\n* bool = isDataType( 'uint8c' );\n* // returns true\n*\n* bool = isDataType( 'foo' );\n* // returns false\n*/\nfunction isDataType( v ) {\n\treturn (\n\t\tisDataTypeString( v ) ||\n\t\tisDataTypeObject( v ) ||\n\t\tisStructDataType( v )\n\t);\n}\n\n\n// EXPORTS //\n\nmodule.exports = isDataType;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Test whether an input value is a supported ndarray data type.\n*\n* @module @stdlib/ndarray-base-assert-is-data-type\n*\n* @example\n* var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\n*\n* var bool = isDataType( 'binary' );\n* // returns true\n*\n* bool = isDataType( 'float32' );\n* // returns true\n*\n* bool = isDataType( 'float64' );\n* // returns true\n*\n* bool = isDataType( 'generic' );\n* // returns true\n*\n* bool = isDataType( 'int16' );\n* // returns true\n*\n* bool = isDataType( 'int32' );\n* // returns true\n*\n* bool = isDataType( 'int8' );\n* // returns true\n*\n* bool = isDataType( 'uint16' );\n* // returns true\n*\n* bool = isDataType( 'uint32' );\n* // returns true\n*\n* bool = isDataType( 'uint8' );\n* // returns true\n*\n* bool = isDataType( 'uint8c' );\n* // returns true\n*\n* bool = isDataType( 'foo' );\n* // returns false\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iDAAkD,EAC9EC,EAAmB,QAAS,iDAAkD,EAC9EC,EAAmB,QAAS,iDAAkD,EAgDlF,SAASC,EAAYC,EAAI,CACxB,OACCJ,EAAkBI,CAAE,GACpBH,EAAkBG,CAAE,GACpBF,EAAkBE,CAAE,CAEtB,CAKAL,EAAO,QAAUI,IChBjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isDataTypeString", "isDataTypeObject", "isStructDataType", "isDataType", "v", "main"]
 }

package/lib/main.js

@@ -20,8 +20,9 @@
 
 // MODULES //
 
-var contains = require( '@stdlib/array-base-assert-contains' ).factory;
-var dtypes = require( '@stdlib/ndarray-dtypes' );
+var isDataTypeString = require( '@stdlib/ndarray-base-assert-is-data-type-string' );
+var isDataTypeObject = require( '@stdlib/ndarray-base-assert-is-data-type-object' );
+var isStructDataType = require( '@stdlib/ndarray-base-assert-is-struct-data-type' );
 
 
 // MAIN //
@@ -29,8 +30,6 @@ var dtypes = require( '@stdlib/ndarray-dtypes' );
 /**
 * Tests whether an input value is a supported ndarray data type.
 *
-* @name isDataType
-* @type {Function}
 * @param {*} v - value to test
 * @returns {boolean} boolean indicating whether an input value is a supported ndarray data type
 *
@@ -71,7 +70,13 @@ var dtypes = require( '@stdlib/ndarray-dtypes' );
 * bool = isDataType( 'foo' );
 * // returns false
 */
-var isDataType = contains( dtypes() );
+function isDataType( v ) {
+	return (
+		isDataTypeString( v ) ||
+		isDataTypeObject( v ) ||
+		isStructDataType( v )
+	);
+}
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-assert-is-data-type",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Test if an input value is a supported ndarray data type.",
   "license": "Apache-2.0",
   "author": {
@@ -30,8 +30,9 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-base-assert-contains": "^0.2.1",
-    "@stdlib/ndarray-dtypes": "^0.2.1"
+    "@stdlib/ndarray-base-assert-is-data-type-object": "github:stdlib-js/ndarray-base-assert-is-data-type-object#main",
+    "@stdlib/ndarray-base-assert-is-data-type-string": "github:stdlib-js/ndarray-base-assert-is-data-type-string#main",
+    "@stdlib/ndarray-base-assert-is-struct-data-type": "github:stdlib-js/ndarray-base-assert-is-struct-data-type#main"
   },
   "devDependencies": {},
   "engines": {
@@ -72,7 +73,6 @@
     "validation",
     "isvalid"
   ],
-  "__stdlib__": {},
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/stdlib"