JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17702
  • Score
    100M100P100Q141047F
  • License Apache-2.0

Standard assertion utilities.

Package Exports

  • @stdlib/assert
  • @stdlib/assert/contains
  • @stdlib/assert/has-arraybuffer-support
  • @stdlib/assert/has-async-iterator-symbol-support
  • @stdlib/assert/has-dataview-support
  • @stdlib/assert/has-define-properties-support
  • @stdlib/assert/has-define-property-support
  • @stdlib/assert/has-float32array-support
  • @stdlib/assert/has-float64array-support
  • @stdlib/assert/has-function-name-support
  • @stdlib/assert/has-generator-support
  • @stdlib/assert/has-int16array-support
  • @stdlib/assert/has-int32array-support
  • @stdlib/assert/has-int8array-support
  • @stdlib/assert/has-iterator-symbol-support
  • @stdlib/assert/has-node-buffer-support
  • @stdlib/assert/has-own-property
  • @stdlib/assert/has-property
  • @stdlib/assert/has-proxy-support
  • @stdlib/assert/has-sharedarraybuffer-support
  • @stdlib/assert/has-symbol-support
  • @stdlib/assert/has-tostringtag-support
  • @stdlib/assert/has-uint16array-support
  • @stdlib/assert/has-uint32array-support
  • @stdlib/assert/has-uint8array-support
  • @stdlib/assert/has-uint8clampedarray-support
  • @stdlib/assert/has-utf16-surrogate-pair-at
  • @stdlib/assert/instance-of
  • @stdlib/assert/is-absolute-path
  • @stdlib/assert/is-alphanumeric
  • @stdlib/assert/is-arguments
  • @stdlib/assert/is-array
  • @stdlib/assert/is-array-array
  • @stdlib/assert/is-array-like
  • @stdlib/assert/is-array-like-object
  • @stdlib/assert/is-arraybuffer
  • @stdlib/assert/is-big-endian
  • @stdlib/assert/is-boolean
  • @stdlib/assert/is-browser
  • @stdlib/assert/is-buffer
  • @stdlib/assert/is-capitalized
  • @stdlib/assert/is-collection
  • @stdlib/assert/is-complex-like
  • @stdlib/assert/is-darwin
  • @stdlib/assert/is-date-object
  • @stdlib/assert/is-empty-array
  • @stdlib/assert/is-empty-object
  • @stdlib/assert/is-enumerable-property
  • @stdlib/assert/is-error
  • @stdlib/assert/is-float32array
  • @stdlib/assert/is-float64array
  • @stdlib/assert/is-function
  • @stdlib/assert/is-function-array
  • @stdlib/assert/is-int16array
  • @stdlib/assert/is-int32array
  • @stdlib/assert/is-int8array
  • @stdlib/assert/is-integer
  • @stdlib/assert/is-iterator-like
  • @stdlib/assert/is-leap-year
  • @stdlib/assert/is-little-endian
  • @stdlib/assert/is-lowercase
  • @stdlib/assert/is-matrix-like
  • @stdlib/assert/is-nan
  • @stdlib/assert/is-node
  • @stdlib/assert/is-node-writable-stream-like
  • @stdlib/assert/is-nonenumerable-property
  • @stdlib/assert/is-nonnegative-integer
  • @stdlib/assert/is-nonnegative-integer-array
  • @stdlib/assert/is-nonnegative-number
  • @stdlib/assert/is-null
  • @stdlib/assert/is-number
  • @stdlib/assert/is-object
  • @stdlib/assert/is-object-like
  • @stdlib/assert/is-plain-object
  • @stdlib/assert/is-positive-integer
  • @stdlib/assert/is-positive-integer-array
  • @stdlib/assert/is-positive-number
  • @stdlib/assert/is-prng-like
  • @stdlib/assert/is-probability
  • @stdlib/assert/is-regexp
  • @stdlib/assert/is-regexp-string
  • @stdlib/assert/is-string
  • @stdlib/assert/is-string-array
  • @stdlib/assert/is-typed-array
  • @stdlib/assert/is-typed-array-like
  • @stdlib/assert/is-uint16array
  • @stdlib/assert/is-uint32array
  • @stdlib/assert/is-uint8array
  • @stdlib/assert/is-uint8clampedarray
  • @stdlib/assert/is-undefined
  • @stdlib/assert/is-undefined-or-null
  • @stdlib/assert/is-unity-probability-array
  • @stdlib/assert/is-uri
  • @stdlib/assert/is-whitespace
  • @stdlib/assert/is-windows
  • @stdlib/assert/is-writable-property
  • @stdlib/assert/tools/array-function

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Assert

NPM version Build Status Coverage Status dependencies

Standard library assertion utilities.

Installation

npm install @stdlib/assert

Usage

var assert = require( '@stdlib/assert' );

assert

Included in this namespace is a comprehensive suite of assertion utilities, such as utilities for testing for various data types and others for testing for JavaScript feature support.

var o = assert;
// returns {...}

To validate the built-in JavaScript data types, the namespace includes the following assertion utilities:

For primitive types having corresponding object wrappers, assertion utilities provide isObject and isPrimitive methods to test for either objects or primitives, respectively.

var isBoolean = require( '@stdlib/assert/is-boolean' );

var bool = isBoolean.isObject( new Boolean( false ) );
// returns true

bool = isBoolean.isObject( false );
// returns false

bool = isBoolean.isPrimitive( false );
// returns true

Many of the assertion utilities have corresponding packages that test whether array elements are of the given data type:

Where applicable, similar to the assertion utilities for built-in data types, array assertion utilities provides methods for testing for an array of primitives or objects.

var isStringArray = require( '@stdlib/assert/is-string-array' );

var bool = isStringArray( [ 'hello', 'world' ] );
// returns true

bool = isStringArray.primitives( [ 'hello', 'world' ] );
// returns true

bool = isStringArray.objects( [ 'hello', 'world' ] );
// returns false

bool = isStringArray.objects( [ new String( 'hello' ), new String( 'world' ) ] );
// returns true

The namespace also contains utilities to test for numbers within a certain range or for numbers satisfying a particular "type":

The namespace provides various utilities for validating typed arrays:

The namespace includes utilities for validating ndarrays (n-dimensional arrays).

The namespace includes utilities for validating complex numbers and arrays of complex numbers:

The namespace includes utilities for validating other special arrays or buffers:

To test for error objects, the namespace includes the following utilities:

The namespace exposes the following constants concerning the current running process:

To test whether a runtime environment supports certain features, the namespace includes the following utilities:

The remaining namespace utilities are as follows:

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var assert = require( '@stdlib/assert' );

console.log( objectKeys( assert ) );

Notice

This package is part of 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, see the main project repository.


License

See LICENSE.

Copyright © 2016-2021. The Stdlib Authors.