Needlessly Promiscuous, Modularize!
Miss any of our Open RFC calls?Watch the recordings here! »

This package has been deprecated

Author message:

No longer maintained! Please use @fiquu/is - https://github.com/fiquu/is

fi-is

4.0.0 • Public • Published

fi-is Build Status

A small general purpose check library with arithmetic, array, environments, object, presence, regexp, string, time and type check functions. Available for Node.js and the browser.

  • No dependencies
  • AMD, Node & browser ready

Originally meant as a drop-in replacement for and forked from is.js.

Usage

Node.js

Install with NPM:

npm install --save fi-is

Use in you application:

const is = require('fi-is');
 
is.nodejs(); // true
is.number(0); // true

Browser

Install with Bower:

bower install --save fi-is

Include the non-minified script for testing and development:

<script src="bower_components/fi-is/dist/fi-is.js"></script>

Or include the minified script for production:

<script src="bower_components/fi-is/dist/fi-is.min.js"></script>

Or, better yet, bundle it with the rest of the scripts.

Documentation

Contributing

Please keep you code tidy and readable and document appropriately using the following schema:

/**
 * Checks for awesomeness.
 *
 * @param {String} str It receives a string or whatever.
 *
 * @returns {Boolean} It must return a boolean.
 *
 * @example
 * is.awesome('fi-is'); // true
 * is.awesome(1); // false
 */
is.awesome = function (str) {
 return is.string(str) && str === 'fi-is';
};

If the method has more than one argument or it's unnecessary to include all of them, define the method's interfaces below it:

// ...
 
is.awesome.api['not'];

To build browser versions (dist):

gulp dist

To run tests:

npm test

To update the documentation files:

gulp docs

One-liner: gulp && npm test

Install

npm i fi-is

DownloadsWeekly Downloads

28

Version

4.0.0

License

MIT

Unpacked Size

723 kB

Total Files

54

Last publish

Collaborators

  • avatar
  • avatar