Check Type
A type checking framework for Javascript.
Check type lets you check variable types and structures with the format check(x).is("y")
and check(x).has("a.b")
Table of Contents
- Dependencies
- Installation
- Use
- Testing
- No Conflict
- Init
- Clear
- Type checking
- Object path checking
- Object structure checking
- Complex example
- Contact
Dependencies
Installation
Node.js
check-type
is available through the npm package manager.
For Node.js package management, you can install using npm.
npm install check-type
Bower
check-type
is available through the bower package manager.
For front-end package management, you can install using Bower.
bower install check-type
Component
check-type
is available through the component package manager.
For package management, you can install using Component.
component install alistairjcbrown/check-type
Manual
For manual management, you can grab the Javascript file directly or clone the git repository.
You will need to grab underscore.js
as well.
# Grab the file
wget https://raw.githubusercontent.com/alistairjcbrown/check-type/master/check-type.min.js
# Clone the repo
git clone git@github.com:alistairjcbrown/check-type.git
Use
Node.js
var check = ;
The module can be required using Node.js built in require
(See example).
Browser
The module can be used in the browser through the <script>
tag and will bind to window
(See example).
RequireJS
The module supports the AMD format and uses define
if available. Therefore it can be used as a RequireJS module (See Browser example, See Node.js example).
;
Testing
Built in tests and linting using Grunt to call JSHint and Mocha.
Get all of the developer dependecies by running:
npm install # install dev dependencies
Test in Node.js
grunt lint # Lint the code with JSHint
grunt test --nodejs # Run all tests in node.js
grunt test --browser # Run all tests in phantomjs
grunt test # Run all tests in both environments
grunt go # Run everything above
Test in Browser
Open lib/test/check-type.test.html
in browser
No Conflict
To prevent conlicts with other libraries using window.check
, if check-type
binds to window
it will also provide a check.noConflict
function to restore the variable to its previous value.
check-type
will only bind to window
in the browser environment when RequireJS is not available.
Init
check-type
does not come with type checking functionality. Instead, it simply provides the check
interface. Type checking functions should be provided when calling check.init
.
check.init
can be called without parameters which will use the type checking functions from Underscore.js.
check.init
can be called multiple times and will add type checking functions which have not already been defined.
To override a previously defined type checking function, pass boolean true
as the second parameter.
Simple use
var check = ;
More complex use
var check = custom_functions = { return value !== -1 } { return value === "empty"; } // Initialise check with underscore type checking functions// and custom checking functions, overriding underscore's isEmpty functioncheck ;
Clear
This clears all of the internal stored type checking functions.
checkclear;
Type checking
Once the check
function has been initialised, it can utilise any defined type checking functions using is
.
is
Example: Checking for string using var my_string = "hello world";check; ; // true; // false ; // throws Error for unsupported type
You can also negate the check with is.not
is.not
Example: Checking for string using var my_string = "hello world";check; is; // falseis; // true is; // throws Error for unsupported type
Object path checking
check-type
can check for the presence of values within an object under a particular path.
has
Example: Checking object path using var my_object = hello: world: false ; ; // true; // false
Object structure checking
check-type
can check an object properties for specific types
matches
Example: Checking object properties using var my_object = "customer_number": 123456789 "password": "abc123"; ;// true ;// false
Complex example
The functionality of check
can be used in combination, for example when validating response data.
See the example below as a jsfiddle.
check-type
Set up var custom_types = {}; custom_types { return /^\w+$/;}; custom_types { return ;}; // Initialise with underscorejs functionscheck; // Add custom functions toocheck;
Retrieve username and password from authentication request
{ var username password; if && username = requestauthusername; password = requestauthpassword; return username: username password: password ; return false;}
Contact
Twitter @alistairjcbrown
Code signed using keybase as alistairjcbrown. Verify with keybase dir verify