Type Enforcer

> A type enforcement library for javascript
>
> [![npm][npm]][npm-url]
[![build][build]][build-url]
[![coverage][coverage]][coverage-url]
[![deps][deps]][deps-url]
[![size][size]][size-url]
[![vulnerabilities][vulnerabilities]][vulnerabilities-url]
[![license][license]][license-url]

Installation

``
npm install type-enforcer
``
_Requires Babel 7.2+_

Objects

assert : object

An assertion library for testing. Assertions do nothing if the test passes, and throw an AssertionError if they fail.

is : object

Utility functions for checking if a value is a particular data type.

enforce : object

Utility functions for enforcing data types.

method : object

Enforce data types and remove common boilerplate code on class methods.

Classes

Enum

Freezes an enumerable object and adds a few helper methods

Queue

A simple queue for callbacks that allows for adding, removing, and triggering all or specific callbacks

Removable

A mixin that adds methods to a class to facilitate clean-up

PrivateVars

A thin wrapper over WeakMap for storing private variables

Functions

abstractEquality(a, b) ⇒ boolean

Performs an abstract equality check (==) between two values.

sameValue(a, b) ⇒ boolean

Performs a SameValue equality check (Object.is) between two values.

sameValueZero(a, b) ⇒ boolean

Performs a SameValueZero equality check between two values.

strictEquality(a, b) ⇒ boolean

Performs a strict equality check (===) between two values.

applySettings(target, settings, [priority], [deferred])

Iterates over the provided settings and calls any methods of the same name, passing the value in as the argument.

castArray(value) ⇒ Array

Casts a value to an array.

[npm]: https://img.shields.io/npm/v/type-enforcer.svg
[npm-url]: https://npmjs.com/package/type-enforcer
[build]: https://travis-ci.org/DarrenPaulWright/type-enforcer.svg?branch=master
[build-url]: https://travis-ci.org/DarrenPaulWright/type-enforcer
[coverage]: https://coveralls.io/repos/github/DarrenPaulWright/type-enforcer/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/DarrenPaulWright/type-enforcer?branch=master
[deps]: https://david-dm.org/DarrenPaulWright/type-enforcer.svg
[deps-url]: https://david-dm.org/DarrenPaulWright/type-enforcer
[size]: https://packagephobia.now.sh/badge?p=type-enforcer
[size-url]: https://packagephobia.now.sh/result?p=type-enforcer
[vulnerabilities]: https://snyk.io/test/github/DarrenPaulWright/type-enforcer/badge.svg?targetFile=package.json
[vulnerabilities-url]: https://snyk.io/test/github/DarrenPaulWright/type-enforcer?targetFile=package.json
[license]: https://img.shields.io/github/license/DarrenPaulWright/type-enforcer.svg
[license-url]: https://npmjs.com/package/type-enforcer/LICENSE.md