A simple assertion interface for validation.
npm install asserted> A simple assertion interface for validation.
A simple extensible interface for validation assertions shipped with the
minimum assertions necessary for robust validations.
Install using npm:
``sh`
npm install asserted
Install using bower:
`sh`
bower install asserted
Using browser script tag and global (UMD wrapper):
`html`
// Available via window.asserted
* class: Assert ⏏
* [new Assert(value, [message])](#exp_new_module_asserted)
* Assert.extend(message, fn)
* [Assert.Type(type, [message])](#module_asserted.Type)
* [Assert.Instance(constructor, [message])](#module_asserted.Instance)
* [Assert.Equals(value, [message])](#module_asserted.Equals)
* [Assert.Enum(set, [message])](#module_asserted.Enum)
* [Assert.Set(assert, [message])](#module_asserted.Set)
* [Assert.Range(range, [message])](#module_asserted.Range)
* [Assert.Length(length, [message])](#module_asserted.Length)
* [Assert.RegExp(regex, [message])](#module_asserted.RegExp)
###new Assert(value, [message])
Create a new assertion with given value.
Check Assert#satisfied and if false a failure message will be availableAssert#message
via .
Params
- value Mixed String
- \[message\] - override default message. %v is replaced with value
Returns: Assert message
###Assert.extend(message, fn)
Extend Assert with given and assertion fn.
Params
- message String - %v is replaced with asserted value function
- fn - assertion function returns boolean
Returns: Assert type
###Assert.Type(type, [message])
Create assertion that value is type of given .
Params
- type String String
- \[message\]
Returns: Assert constructor
###Assert.Instance(constructor, [message])
Create assertion that value is instance of given .
Params
- constructor function String
- \[message\]
Returns: Assert value
###Assert.Equals(value, [message])
Create assertion that value is equal to given .
Params
- value Mixed String
- \[message\]
Returns: Assert set
###Assert.Enum(set, [message])
Create assertion that value is in given .
Params
- set Array String
- \[message\]
Returns: Assert assert
###Assert.Set(assert, [message])
Create assertion that value array members satisfy the given .
Params
- assert Assert String
- \[message\]
Returns: Assert range
###Assert.Range(range, [message])
Create assertion that number value is within given .
Params
- range Object Number
- min Number
- max String
- \[message\]
Returns: Assert length
###Assert.Length(length, [message])
Create assertion that string or array value has given .
Params
- length Object | Number Number
- \[min\] Number
- \[max\] String
- \[message\]
Returns: Assert regex
###Assert.RegExp(regex, [message])
Create assertion that value matches given .
Params
- regex RegExp String
- \[message\]
Returns: Assert
Please submit all issues and pull requests to the alexmingoia/asserted repository!
Run tests using npm test or gulp test.
Generate code coverage using gulp coverage and open coverage.html` in your
web browser.
If you have any problem or suggestion please open an issue here.