@stdlib/array-base-assert

Base array assertion utilities.

https://github.com/stdlib-js/array-base-assert

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.4%) to scientific vocabulary

Keywords

assert assertion check javascript node node-js nodejs stdlib test validate verify

Last synced: 6 months ago · JSON representation ·

Repository

Base array assertion utilities.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 5.44 MB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

assert assertion check javascript node node-js nodejs stdlib test validate verify

Created about 3 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

assert

Base array assertion utilities.

## Installation ```bash npm install @stdlib/array-base-assert ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var ns = require( '@stdlib/array-base-assert' ); ``` #### ns Assertion utilities. ```javascript var o = ns; // returns {...} ``` The namespace exports the following:

- [`contains( x, value )`][@stdlib/array/base/assert/contains]: test if an array contains a provided search value. - [`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]: test if two indexed arrays have equal values. - [`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]: test if two arrays have equal values. - [`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]: test if two arrays have the same values. - [`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]: test if an array-like object supports the accessor (get/set) protocol. - [`isBooleanDataType( value )`][@stdlib/array/base/assert/is-boolean-data-type]: test if an input value is a supported array boolean data type. - [`isBooleanArray( value )`][@stdlib/array/base/assert/is-booleanarray]: test if a value is a `BooleanArray`. - [`isByteOrder( value )`][@stdlib/array/base/assert/is-byte-order]: test if an input value is a supported array byte order. - [`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported array complex-valued floating-point data type. - [`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]: test if a value is a complex typed array. - [`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]: test if a value is a `Complex128Array`. - [`isComplex64Array( value )`][@stdlib/array/base/assert/is-complex64array]: test if a value is a `Complex64Array`. - [`isDataType( value )`][@stdlib/array/base/assert/is-data-type]: test if an input value is a supported array data type. - [`isFloatingPointDataType( value )`][@stdlib/array/base/assert/is-floating-point-data-type]: test if an input value is a supported array floating-point data type. - [`isIntegerDataType( value )`][@stdlib/array/base/assert/is-integer-data-type]: test if an input value is a supported array integer data type. - [`isMostlySafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-mostly-safe-data-type-cast]: determine whether an array data type can be safely cast or, for floating-point data types, downcast to another array data type. - [`isNumericDataType( value )`][@stdlib/array/base/assert/is-numeric-data-type]: test if an input value is a supported array numeric data type. - [`isRealDataType( value )`][@stdlib/array/base/assert/is-real-data-type]: test if an input value is a supported array real-valued data type. - [`isRealFloatingPointDataType( value )`][@stdlib/array/base/assert/is-real-floating-point-data-type]: test if an input value is a supported array real-valued floating-point data type. - [`isSafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-safe-data-type-cast]: determine whether an array data type can be safely cast to another array data type. - [`isSameKindDataTypeCast( from, to )`][@stdlib/array/base/assert/is-same-kind-data-type-cast]: determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type. - [`isSignedIntegerDataType( value )`][@stdlib/array/base/assert/is-signed-integer-data-type]: test if an input value is a supported array signed integer data type. - [`isSortedAscending( x )`][@stdlib/array/base/assert/is-sorted-ascending]: test if an array is sorted in ascending order. - [`isUnsignedIntegerDataType( value )`][@stdlib/array/base/assert/is-unsigned-integer-data-type]: test if an input value is a supported array unsigned integer data type.

## Examples ```javascript var ns = require( '@stdlib/array-base-assert' ); var dtype = require( '@stdlib/array-dtype' ); var Float64Array = require( '@stdlib/array-float64' ); var Int32Array = require( '@stdlib/array-int32' ); var Uint8Array = require( '@stdlib/array-uint8' ); var Complex128Array = require( '@stdlib/array-complex128' ); // Create various arrays: var arr1 = new Float64Array( [ 1.1, 2.2, 3.3 ] ); var arr2 = new Int32Array( [ 1, 2, 3 ] ); var arr3 = new Uint8Array( [ 1, 2, 3 ] ); var arr4 = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0 ] ); // two complex numbers: 1+1i, 2+2i // Get data types: var dt1 = dtype( arr1 ); var dt2 = dtype( arr2 ); var dt3 = dtype( arr3 ); var dt4 = dtype( arr4 ); // Check data types: console.log( dt1 + ' is floating-point data type: ' + ns.isFloatingPointDataType( dt1 ) ); // => 'float64 is floating-point data type: true' console.log( dt2 + ' is integer data type: ' + ns.isIntegerDataType( dt2 ) ); // => 'int32 is integer data type: true' console.log( dt3 + ' is unsigned integer data type: ' + ns.isUnsignedIntegerDataType( dt3 ) ); // => 'uint8 is unsigned integer data type: true' console.log( dt4 + ' is complex floating-point data type: ' + ns.isComplexFloatingPointDataType( dt4 ) ); // => 'complex128 is complex floating-point data type: true' // Check if arrays have the same values: console.log( 'arr2 and arr3 have same values: ' + ns.hasSameValues( arr2, arr3 ) ); // => 'arr2 and arr3 have same values: true' console.log( 'arr1 and arr2 have same values: ' + ns.hasSameValues( arr1, arr2 ) ); // => 'arr1 and arr2 have same values: false' // Check safe data type casts: console.log( 'Can safely cast from ' + dt2 + ' to ' + dt1 + ': ' + ns.isSafeDataTypeCast( dt2, dt1 ) ); // => 'Can safely cast from int32 to float64: true' console.log( 'Can safely cast from ' + dt1 + ' to ' + dt2 + ': ' + ns.isSafeDataTypeCast( dt1, dt2 ) ); // => 'Can safely cast from float64 to int32: false' console.log( 'Can safely cast from ' + dt3 + ' to ' + dt2 + ': ' + ns.isSafeDataTypeCast( dt3, dt2 ) ); // => 'Can safely cast from uint8 to int32: true' console.log( 'Can safely cast from ' + dt4 + ' to ' + dt1 + ': ' + ns.isSafeDataTypeCast( dt4, dt1 ) ); // => 'Can safely cast from complex128 to float64: false' // Check if arrays contain specific values: console.log( 'arr1 contains 2.2: ' + ns.contains( arr1, 2.2 ) ); // => 'arr1 contains 2.2: true' console.log( 'arr2 contains 2: ' + ns.contains( arr2, 2 ) ); // => 'arr2 contains 2: true' console.log( 'arr2 contains 2.2: ' + ns.contains( arr2, 2.2 ) ); // => 'arr2 contains 2.2: false' // Check complex array types: console.log( 'arr4 is Complex128Array: ' + ns.isComplex128Array( arr4 ) ); // => 'arr4 is Complex128Array: true' console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) ); // => 'arr4 is complex typed array: true' ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. 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 See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

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

GitHub Events

Total

Push event: 64

Last Year

Push event: 64

Committers

Last synced: about 2 years ago

All Time

Total Commits: 26
Total Committers: 1
Avg Commits per committer: 26.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 19
Committers: 1
Avg Commits per committer: 19.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	26

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 11 last-month

Total dependent packages: 1
Total dependent repositories: 0
Total versions: 5
Total maintainers: 4

npmjs.org: @stdlib/array-base-assert

Base array assertion utilities.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.3.0
published over 1 year ago

Versions: 5
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 11 Last month

Rankings

Forks count: 20.5%

Stargazers count: 22.1%

Dependent repos count: 25.3%

Average: 28.5%

Dependent packages count: 32.9%

Downloads: 41.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

package.json npm

@stdlib/array-complex128 ^0.0.x development
@stdlib/array-complex64 ^0.0.x development
@stdlib/array-float32 ^0.0.x development
@stdlib/array-float64 ^0.0.x development
@stdlib/array-int16 ^0.0.x development
@stdlib/array-int32 ^0.0.x development
@stdlib/array-int8 ^0.0.x development
@stdlib/array-uint16 ^0.0.x development
@stdlib/array-uint32 ^0.0.x development
@stdlib/array-uint8 ^0.0.x development
@stdlib/array-uint8c ^0.0.x development
@stdlib/assert-is-boolean ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/buffer-alloc-unsafe ^0.0.x development
@stdlib/utils-constructor-name ^0.0.x development
@stdlib/utils-keys ^0.0.x development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-assert-is-accessor-array ^0.0.x
@stdlib/utils-define-read-only-property ^0.0.x

@stdlib/array-base-assert

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

assert

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/array-base-assert

Rankings

Maintainers (4)

Funding

Dependencies