@lynchbox/assert

Assert

A simple Javascript library which contains assertions and guard methods for input validation, heavily inspired by beberlei/assert for PHP.

Installation

npm install @lynchbox/assert;

List of assertions

import assert from @lynchbox/assert;

assert(value: number).between(lowerlimit: number, upperLimit: number);
assert(value: string).contains('surely');
assert(value: string).eq('same');
assert(value: number).moreThanOrEqualTo(limit: number);
assert(value: number).lessThanOrEqualTo(limit: number);
assert(value: any).isIn(source: Array<any>);
assert(value: string).endsWith(needle: string);
assert(value: string).startsWith(needle: string);
assert(value: Array<any>).uniqueValues();
assert(value: number).moreThan(limit: number);
assert(value: number).lessThan(limit: number);

Running Tests

Tests are written using Jest.

npm run test

Code Coverage

npm run coverage

Compile Typescript

npm run build