Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@meltwater/coerce

0.3.0 • Public • Published

@meltwater/coerce

Build Status A simple javascript package for type checking an object

Install

npm i --save @meltwater/coerce

API reference

Please see full api documentation here

Usage

class ValidatedObject {
    constructor({ value }) {
        if(typeof value !== string) {
            throw new TypeError(`options.value must be a string. Provided value: ${value}`);
        }
 
        this.value = value;
        Object.freeze(this);
    }
}
 
const badValue = { value: 1234 };
coerce(badValue, ValidatedObject, 'Booooooom!');
// This will throw a TypeError with the message 'Booooooom!'
 
const goodValue = { value: 'so good' };
const typedValue = coerce(goodValue, ValidatedObject, 'Booooooom');
// This will return a new object that is an instanceof ValidatedObject with typedValue.value === 'so good'

Install

npm i @meltwater/coerce

DownloadsWeekly Downloads

2,800

Version

0.3.0

License

MIT

Unpacked Size

11.3 kB

Total Files

7

Last publish

Collaborators

  • avatar