robb/README.md

Simple type checker in JavaScript.

# Robb

[![Build Status](https://secure.travis-ci.org/Baggz/Robb.png)](http://travis-ci.org/Baggz/Robb)

### Contents

* [Example](#example)
* [Download](#download)
* [Usage](#usage)
* [Methods](#methods)
* [Tests](#tests)
* [License](#license)

Robb is simple type checker in JavaScript. It was originally designed for use with [Node.js](http://nodejs.org/), but you can use it also in the browser.

### Features

* Robb has **no dependencies**
* **AMD compatible**, you can load it via [RequireJS](https://github.com/jrburke/requirejs)
* Lightweight
* Fully **documented**

<a name="example"></a>
# Example

```javascript
Robb.isNuber(123); // => true
Robb.isArray([1, 2, 3]); // => true
Robb.isBoolean(false); // => true
Robb.isEmail('hello1@example.com', 'hello2@example.com'); // => true
```

<a name="download"></a>
# Download

To install **Robb**, use [NPM](http://npmjs.org/).

```
$ npm install robb
```

Releases are available for download from GitHub.

| **Version** | **Description** | **Size** | **Action** |
|:------------|:----------------|:---------|:-----------|
| `robb.js` | *uncompressed, with comments* | 1 KB | [Download](https://raw.github.com/Baggz/Robb/master/src/robb.js) |
| `robb.min.js` | *compressed, without comments* | 1 KB | [Download](https://raw.github.com/Baggz/Robb/master/dist/robb.min.js) |

<a name="usage"></a>
# Usage

## Browser

```
<script src="robb.js"></script>
```

## Node.js, RingoJS, Narwhal

```javascript
var platform = require('platform');
```

## RequireJS

```javascript
// Configuration options, the path should not include the .js extension
require.config({
  paths: {
    "robb": "path/to/robb"
  }
});

// Load Robb
require(['robb'], function(robb) {

  // Do something...

});
```
<a name="methods"></a>
# Methods

* isAlpha
* isAlphanumeric
* isArguments
* isArray
* isBoolean
* isDate
* isDecimal
* isDefined
* isElement
* isEmail
* isEmpty
* isEven
* isFinite
* isFunction
* isInt
* isIp
* isIpv4
* isIpv6
* isLowercase
* isNaN
* isNegative
* isNull
* isNumber
* isObject
* isOdd
* isPercentage
* isPort
* isPositive
* isPrime
* isRegExp
* isString
* isUndefined
* isUnsignedInt
* isUppercase
* isUrl
* isWindow

<a name="tests"></a>
# Tests

```
$ npm test
```

<a name="license"></a>
# License

(The MIT License)

Copyright (c) 2011 František Hába &lt;hello@frantisekhaba.com&gt;

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.