doc-home.md

to be, or not to be, that is the question

Simple, light-weight assertions framework for javascript

More than 190 validation methods

Installation

Node.js

npm install bejs --save

Browser

Local

<script src="node_modules/bejs/dist/be.min.js"></script>

CDN unpkg

<script src="https://unpkg.com/bejs/dist/be.min.js"></script>

CDN jsDeliver

<script src="https://cdn.jsdelivr.net/npm/bejs/dist/be.min.js"></script>

Example

const be = require('bejs');

// call a method
be.boolean(true);

// call interface "not"
be.not.boolean(1);

// call interface "all" and passing arguments
be.all.boolean(true, false, true);

// call interface "all" and passing array
be.all.boolean([true, false, true]);

// call interface "any" and passing arguments
be.any.boolean(true, false, 1);

// call interface "err" to throw an error if assertions  are not satisfied
be.err.equal('hello world', 'hello world!'); // throw AssertionError

// call interface "err" passing a custom error message
be.err('the string must be equal to "hello world!"').equal('hello world', 'hello world!'); // throw AssertionError

// call others interfaces from "err"
be.err.any.array([], {}, '');

As unit test with Mocha

describe('a test', () => {
    it('should be ok', (done)=>{
        be.err(done).email('[email protected]');
    });
    
    it('should be false', ()=>{
        be.err.false(2 === 3);
    });
});

Changelog

You can view the changelog here

License

beJS is open-sourced software licensed under the MIT license

Author

Fabio Ricali

Davide Polano