type-mark
v2.0.0
Published
A small library for checking types
Downloads
12
Maintainers
Readme
type-mark
Why use type-mark
Because typeof
just doesn't cut it. The canonical example being
> typeof null
"object"
With type-mark checking for null
is as easy as
> type(null).object
false
Not to mention the added benifits of modifiers, interfaces, and custom validation.
Get It
On the Client
You can use the rawgit CDN to get the latest minified version
<script type="text/javascript" src="https://cdn.rawgit.com/ejrbuss/type-mark/b33a3d5646d5cf4d280ab97d73c776c5522dae90/type-mark.min.js'"></script>
Or you can include your own. Just save a copy of the minified file to your site's javascript directory.
<script type="text/javascript" src="js/type-mark.min.js"></script>
Using any of the above methods will make type-check available via your
choice of commonjs interface. If require
is not defined type-check defines
type
on the window. You can use type.collision
to access any previous
value of window.type
.
On Node
type-mark is available through npm. When using node.js you can install using npm
$ npm install type-mark
To use type-mark in your Node project you will need to require it
var type = require('type-mark');
From Scratch
You can also clone the git repository if you want the full source or are interested in making modifications. type-check is dependency free so working with it is as easy as cloning.
$ git clone https://github.com/ejrbuss/type-mark.git
To run the npm scripts you will need to run npm install
as well as the
following global dependencies
The following npm scripts are made available
$ npm run test # run tests and code coverage
$ npm run build # build type-mark.js and type-mark.min.js for the client
$ npm run site # run the docs site
$ npm run version # update version number and cdn