@stdlib/ndarray-base-assert-is-read-only 0.1.1 → 0.2.1

package/NOTICE

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

package/README.md

@@ -164,7 +164,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -177,8 +177,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-assert-is-read-only.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-assert-is-read-only
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/actions/workflows/test.yml/badge.svg?branch=v0.1.1
-[test-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/actions/workflows/test.yml?query=branch:v0.1.1
+[test-image]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/actions/workflows/test.yml/badge.svg?branch=v0.2.1
+[test-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/actions/workflows/test.yml?query=branch:v0.2.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-assert-is-read-only/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-assert-is-read-only?branch=main
@@ -201,8 +201,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/tree/deno
+[deno-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/tree/umd
+[umd-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/tree/esm
+[esm-readme]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/ndarray-base-assert-is-read-only/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-assert-is-read-only/main/LICENSE

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.js

@@ -1,5 +1,5 @@
-"use strict";var a=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var t=a(function(c,s){
-function i(e){var r=e.flags;return r&&r.READONLY===!0}s.exports=i
-});var u=t();module.exports=u;
+"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var i=s(function(o,t){
+var u=require('@stdlib/ndarray-base-flag/dist');function a(e){return u(e,"READONLY")===!0}t.exports=a
+});var n=i();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) 2022 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// MAIN //\n\n/**\n* Tests whether an ndarray is read-only.\n*\n* @param {ndarray} arr - input ndarray\n* @returns {boolean} boolean indicating whether an ndarray is read-only\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ 1, 2, 3, 4 ], {\n*     'readonly': true\n* });\n* var bool = isReadOnly( x );\n* // returns true\n*\n* x = array( [ 1, 2, 3, 4 ] );\n* bool = isReadOnly( x );\n* // returns false\n*/\nfunction isReadOnly( arr ) {\n\tvar flags = arr.flags;\n\treturn ( flags && flags.READONLY === true );\n}\n\n\n// EXPORTS //\n\nmodule.exports = isReadOnly;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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 ndarray is read-only.\n*\n* @module @stdlib/ndarray-base-assert-is-read-only\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' );\n*\n* var x = array( [ 1, 2, 3, 4 ], {\n*     'readonly': true\n* });\n* var bool = isReadOnly( x );\n* // returns true\n*\n* x = array( [ 1, 2, 3, 4 ] );\n* bool = isReadOnly( x );\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,cAyCA,SAASC,EAAYC,EAAM,CAC1B,IAAIC,EAAQD,EAAI,MAChB,OAASC,GAASA,EAAM,WAAa,EACtC,CAKAH,EAAO,QAAUC,ICPjB,IAAIG,EAAO,IAKX,OAAO,QAAUA",
-  "names": ["require_main", "__commonJSMin", "exports", "module", "isReadOnly", "arr", "flags", "main"]
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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 flag = require( '@stdlib/ndarray-base-flag' );\n\n\n// MAIN //\n\n/**\n* Tests whether an ndarray is read-only.\n*\n* @param {ndarray} arr - input ndarray\n* @returns {boolean} boolean indicating whether an ndarray is read-only\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ 1, 2, 3, 4 ], {\n*     'readonly': true\n* });\n* var bool = isReadOnly( x );\n* // returns true\n*\n* x = array( [ 1, 2, 3, 4 ] );\n* bool = isReadOnly( x );\n* // returns false\n*/\nfunction isReadOnly( arr ) {\n\treturn ( flag( arr, 'READONLY' ) === true );\n}\n\n\n// EXPORTS //\n\nmodule.exports = isReadOnly;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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 ndarray is read-only.\n*\n* @module @stdlib/ndarray-base-assert-is-read-only\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' );\n*\n* var x = array( [ 1, 2, 3, 4 ], {\n*     'readonly': true\n* });\n* var bool = isReadOnly( x );\n* // returns true\n*\n* x = array( [ 1, 2, 3, 4 ] );\n* bool = isReadOnly( x );\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,EAAO,QAAS,2BAA4B,EAwBhD,SAASC,EAAYC,EAAM,CAC1B,OAASF,EAAME,EAAK,UAAW,IAAM,EACtC,CAKAH,EAAO,QAAUE,ICXjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "flag", "isReadOnly", "arr", "main"]
 }

package/docs/types/index.d.ts

@@ -29,7 +29,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns boolean indicating whether an ndarray is read-only
 *
 * @example
-* var array = require( `@stdlib/ndarray/array` );
+* var array = require( '@stdlib/ndarray-array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
 *     'readonly': true

package/lib/main.js

@@ -18,6 +18,11 @@
 
 'use strict';
 
+// MODULES //
+
+var flag = require( '@stdlib/ndarray-base-flag' );
+
+
 // MAIN //
 
 /**
@@ -40,8 +45,7 @@
 * // returns false
 */
 function isReadOnly( arr ) {
-	var flags = arr.flags;
-	return ( flags && flags.READONLY === true );
+	return ( flag( arr, 'READONLY' ) === true );
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-assert-is-read-only",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Test if an ndarray is read-only.",
   "license": "Apache-2.0",
   "author": {
@@ -15,19 +15,12 @@
   ],
   "main": "./lib",
   "directories": {
-    "benchmark": "./benchmark",
     "doc": "./docs",
-    "example": "./examples",
     "lib": "./lib",
-    "test": "./test"
+    "dist": "./dist"
   },
   "types": "./docs/types",
-  "scripts": {
-    "test": "make test",
-    "test-cov": "make test-cov",
-    "examples": "make examples",
-    "benchmark": "make benchmark"
-  },
+  "scripts": {},
   "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
@@ -37,16 +30,9 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/types": "^0.1.0"
-  },
-  "devDependencies": {
-    "@stdlib/assert-is-boolean": "^0.1.0",
-    "@stdlib/bench": "^0.1.0",
-    "@stdlib/ndarray-array": "^0.1.0",
-    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
-    "istanbul": "^0.4.1",
-    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+    "@stdlib/ndarray-base-flag": "^0.2.1"
   },
+  "devDependencies": {},
   "engines": {
     "node": ">=0.10.0",
     "npm": ">2.7.0"

package/CITATION.cff

@@ -1,30 +0,0 @@
-cff-version: 1.2.0
-title: stdlib
-message: >-
-  If you use this software, please cite it using the
-  metadata from this file.
-
-type: software
-
-authors:
-  - name: The Stdlib Authors
-    url: https://github.com/stdlib-js/stdlib/graphs/contributors
-
-repository-code: https://github.com/stdlib-js/stdlib
-url: https://stdlib.io
-
-abstract: |
-  Standard library for JavaScript and Node.js.
-
-keywords:
-  - JavaScript
-  - Node.js
-  - TypeScript
-  - standard library
-  - scientific computing
-  - numerical computing
-  - statistical computing
-
-license: Apache-2.0 AND BSL-1.0
-
-date-released: 2016