Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
breed - npm Package Compare versions
Comparing version 0.2.0 to 0.2.1
| { | ||
| "name": "breed", | ||
| "description": "Breed is a Helper Module which makes working with types and typeof easy as easy as it should be", | ||
| "version": "0.2.0", | ||
| "homepage": "https://github.com/hereandnow/node-breed", | ||
| "version": "0.2.1", | ||
| "homepage": "http://hereandnow.github.com/node-breed/", | ||
| "author": { | ||
@@ -7,0 +7,0 @@ "name": "Bastian Behrens", |
200
README.md
| # Breed | ||
| Breed is a Helper Module which makes working with types and typeof easy as easy as it should be. | ||
| ## About | ||
| You are even able to extend Breed with [registering your own Classes](#register-your-own-classes-1) and do checks like this: | ||
| Breed is a Helper Module which makes working with types and typeof as easy as it should be. | ||
| ``` | ||
| function Person () {} | ||
| breed.register(Person); | ||
| breed.isPerson(new Person()); // true | ||
| ``` | ||
| You are even able to extend Breed with your own Functions. | ||
| You can find the [complete Documentation here](http://hereandnow.github.com/node-breed/) | ||
| ##Table of Contents | ||
| - [Getting Started](#getting-started) | ||
| - [Documentation](#documentation) | ||
| - [Basic Supported Types](#basic-supported-types) | ||
| - [is… and isnt…](#is-and-isnt) | ||
| - [is](#is) | ||
| - [Constants](#constants) | ||
| - [Register your own Classes](#register-your-own-classes) | ||
| - [Examples](#examples) | ||
| - [Basic Supported Types](#basic-supported-types-1) | ||
| - [Register your own Classes](#register-your-own-classes-1) | ||
| - [Contributing](#contributing) | ||
| - [Release History](#release-history) | ||
| - [License](#license) | ||
| ## Getting Started | ||
| Install the module with: `npm install breed` | ||
@@ -37,162 +16,11 @@ | ||
| var breed = require('breed'); | ||
| breed.isArray([]); // true | ||
| breed.isntArray([]); // false | ||
| breed.is([]) // 'array' | ||
| breed.ARRAY // 'array' | ||
| function Person () {} | ||
| breed.register(Person); | ||
| breed.isObect(new Person()); // true | ||
| breed.isPerson(new Person()); // true | ||
| breed.isArray(new Person()); // false | ||
| breed.isntPerson(new Person()); // false | ||
| ``` | ||
| ## Documentation | ||
| ### Basic Supported Types | ||
| * Null | ||
| * Object | ||
| * Array | ||
| * Date | ||
| * RegExp | ||
| * Error | ||
| * Number | ||
| * Function | ||
| * String | ||
| * Undefined | ||
| * JSON | ||
| * Finite | ||
| * NaN | ||
| * Error | ||
| * EvalError | ||
| * InternalError | ||
| * RangeError | ||
| * ReferenceError | ||
| * SyntaxError | ||
| * TypeError | ||
| * URIError | ||
| ### is… and isnt... | ||
| Breed always has for every Type 2 Functions: | ||
| ``` | ||
| breed.is... | ||
| breed.isnt... | ||
| ``` | ||
| for example: | ||
| ``` | ||
| breed.isFunction() | ||
| breed.isntFunction() | ||
| // or | ||
| breed.isUndefined() | ||
| breed.isntUndefined() | ||
| // or | ||
| breed.isJSON() | ||
| breed.isntJSON() | ||
| // … and so on | ||
| ``` | ||
| There is 1 exceptional Case where isInfinite is just a little bit nicer than isntFinite, so both Cases are supported: | ||
| ``` | ||
| breed.isntFinite() === breed.isInfinite() | ||
| ``` | ||
| ### is | ||
| You are also able to check via breed's is-Function which will always return the type as a String: | ||
| ``` | ||
| breed.is([]) // 'array' | ||
| breed.is(1) // 'number' | ||
| breed.is({}) // 'object' | ||
| ... | ||
| ``` | ||
| ### Constants | ||
| Every type has its 'Constant' Variable (always uppercase) whos value is always lowercase: | ||
| ``` | ||
| breed.ARRAY // 'array' | ||
| breed.NUMBER // 'number' | ||
| breed.OBJECT // 'object' | ||
| ... | ||
| ``` | ||
| So you can combine it with the is-Function: | ||
| ``` | ||
| breed.is([]) === breed.ARRAY // true | ||
| breed.is(1) === breed.NUMBER // true | ||
| breed.is({}) === breed.OBJECT // true | ||
| ... | ||
| ``` | ||
| ### Register your own Classes | ||
| Just add as much Classes as you want: | ||
| ``` | ||
| breed.register(*functions) | ||
| ``` | ||
| The best about that is, that breed.register even supports Inheritance (see the example: [Register your own Classes](#register-your-own-classes-1)) | ||
| ## Examples | ||
| ### Basic Supported Types | ||
| ``` | ||
| // some Functions | ||
| breed.isObject({}) // true | ||
| breed.isFunction(function () {}) // true | ||
| breed.isntDate(new Date()) // false | ||
| breed.isntUndefined() // false | ||
| // errors all have the super-constructor Error | ||
| breed.isRangeError(new RangeError()) // true | ||
| breed.isError(new RangeError()) // true | ||
| // some constants | ||
| breed.ERROR // 'error' | ||
| breed.RANGEERROR // 'rangeerror' | ||
| breed.DATE // 'date' | ||
| breed.ARRAY // 'array' | ||
| ``` | ||
| ### Register your own Classes | ||
| ``` | ||
| var breed = require('breed'); | ||
| var util = require('util'); | ||
| // your code creates some Functions | ||
| function Person () {} | ||
| function Child () {} | ||
| function Mom () {} | ||
| util.inherits(Child, Person); | ||
| util.inherits(Mom, Person); | ||
| // register your classes | ||
| breed.register(Person, Child, Mom); | ||
| // do typechecking | ||
| breed.isPerson(new Person()) // true | ||
| breed.isChild(new Child()) // true | ||
| breed.isPerson(new Child()) // true | ||
| breed.isMom(new Mom()) // true | ||
| breed.isPerson(new Mom()) // true | ||
| breed.isntChild(new Mom()) // true | ||
| // constants | ||
| breed.PERSON // 'person' | ||
| breed.CHILD // 'child' | ||
| breed.MOM // 'mom' | ||
| ``` | ||
| ## Contributing | ||
@@ -209,4 +37,8 @@ In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/): | ||
| - 0.2.0 Second Release | ||
| - Implement JSOn, NaN, Finite | ||
| - 0.2.1 | ||
| - Move Documentation to http://hereandnow.github.com/node-breed/ | ||
| - Fix some typos in Docs | ||
| - 0.2.0 | ||
| - Implement JSON, NaN, Finite | ||
| - author breed.register() | ||
@@ -213,0 +45,0 @@ - rename breed.get() to breed.is() |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by5%
21
Worsened metrics
- Total package byte prevSize
- decreased by-9.09%
29252
- Number of low quality alerts
- increased by100%
2
- Number of lines in readme file
- decreased by-76.71%
51
No dependency changes