asserted v1.1.0

asserted

A simple assertion interface for validation.

A simple extensible interface for validation assertions shipped with the minimum assertions necessary for robust validations.

Installation

Install using npm:

npm install asserted

Install using bower:

bower install asserted

Using browser script tag and global (UMD wrapper):

// Available via window.asserted
<script src="dist/asserted.js"></script>

API Reference

##class: Assert ⏏ Members

• class: Assert ⏏
  • new Assert(value, [message])
  • Assert.extend(message, fn)
  • Assert.Type(type, [message])
  • Assert.Instance(constructor, [message])
  • Assert.Equals(value, [message])
  • Assert.Enum(set, [message])
  • Assert.Set(assert, [message])
  • Assert.Range(range, [message])
  • Assert.Length(length, [message])
  • Assert.RegExp(regex, [message])

###new Assert(value, message) Create a new assertion with given value.

Check Assert#satisfied and if false a failure message will be available via Assert#message.

Params

• value Mixed
• [message] String - override default message. %v is replaced with value

Returns: Assert
###Assert.extend(message, fn) Extend Assert with given message and assertion fn.

Params

• message String - %v is replaced with asserted value
• fn function - assertion function returns boolean

Returns: Assert
###Assert.Type(type, message) Create assertion that value is type of given type.

Params

• type String
• [message] String

Returns: Assert
###Assert.Instance(constructor, message) Create assertion that value is instance of given constructor.

Params

• constructor function
• [message] String

Returns: Assert
###Assert.Equals(value, message) Create assertion that value is equal to given value.

Params

• value Mixed
• [message] String

Returns: Assert
###Assert.Enum(set, message) Create assertion that value is in given set.

Params

• set Array
• [message] String

Returns: Assert
###Assert.Set(assert, message) Create assertion that value array members satisfy the given assert.

Params

• assert Assert
• [message] String

Returns: Assert
###Assert.Range(range, message) Create assertion that number value is within given range.

Params

• range Object
  • min Number
  • max Number
• [message] String

Returns: Assert
###Assert.Length(length, message) Create assertion that string or array value has given length.

Params

• length Object | Number
  • [min] Number
  • [max] Number
• [message] String

Returns: Assert
###Assert.RegExp(regex, message) Create assertion that value matches given regex.

Params

• regex RegExp
• [message] String

Returns: Assert

Contributing

Please submit all issues and pull requests to the alexmingoia/asserted repository!

Tests

Run tests using npm test or gulp test.

Code coverage

Generate code coverage using gulp coverage and open coverage.html in your web browser.

Support

If you have any problem or suggestion please open an issue here.