@stdlib/assert
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.12 • Public • Published

    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:

    • IS_BIG_ENDIAN: check if an environment is big endian.
    • IS_BROWSER: check if the runtime is a web browser.
    • IS_DARWIN: boolean indicating if the current process is running on Darwin.
    • IS_DOCKER: check if the process is running in a Docker container.
    • IS_ELECTRON_MAIN: check if the runtime is the main Electron process.
    • IS_ELECTRON_RENDERER: check if the runtime is the Electron renderer process.
    • IS_ELECTRON: check if the runtime is Electron.
    • IS_LITTLE_ENDIAN: check if an environment is little endian.
    • IS_MOBILE: check if the current environment is a mobile device.
    • IS_NODE: check if the runtime is Node.js.
    • IS_TOUCH_DEVICE: check if the current environment is a touch device.
    • IS_WEB_WORKER: check if the runtime is a web worker.
    • IS_WINDOWS: boolean indicating if the current process is running on Windows.

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    7,936

    Version

    0.0.12

    License

    Apache-2.0

    Unpacked Size

    3.27 MB

    Total Files

    2108

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser