@typeforce/is-symbol

is-symbol

Determine if a value is a symbol.

Usage

    npm install @typeforce/is-symbol --save   # Install package via NPM

    import { expect } from "chai";
    import isSymbol from "@typeforce/is-symbol";

    expect(isSymbol(Symbol("Boo"))).to.be.true;
    expect(isSymbol(Symbol())).to.be.true;

    expect(isSymbol(undefined)).to.be.false;
    expect(isSymbol(null)).to.be.false;
    expect(isSymbol(42)).to.be.false;

This package contains TypeScript type declarations. Furthermore, the package uses TypeScript type guards to allow type inference to influence IntelliSense.

    if (isSymbol(x)) {
        // IntelliSense now knows `x` is a symbol.
        let y: symbol = x;
    }

Content Delivery Network (CDN)

This package can be imported via unpkg as demonstrated below.

    <script src="https://unpkg.com/@typeforce/is-symbol/dist/index.min.js"></script>
    <script type="application/javascript">
        var x = Symbol("foo");
        if (isSymbol(x)) {
            // `x` is a symbol!
        }
    </script>

Build & Test

When building the project, a folder named dist/ will be created if it does not already exist, where the compiled code will be outputted to. Type declaration files will also be generated and outputted to the dist/ folder.

A minified Javascript version of the entire project will be generated and outputted to dist/index.min.js.

    npm install     # Installs dependencies.
    npm run build   # Build the project.

This package uses Gulp for building, and Chai and Mocha for testing.

    npm test       # Run tests.

License

Refer to the LICENSE file for license information.