humanizejs v1.0.0

humanizejs

##Getting started

###Bower

bower install humanizejs

<script src="bower_components/humanizejs/dist/humanize.min.js"></script>

###NPM

npm install humanizejs

var humanize = require('humanizejs')

###Angular

angular.module('app', ['ngHumanize'])

##Usage

###File Size

Converts byte size to human readable string

var result = humanize.toFileSize(BYTE_SIZE, [DECIMAL_PLACE]); //DECIMAL_PLACE defaults to 2.

Eg

var result1 = humanize.toFileSize(123456789);     //result1 = 117.74 MB
var result2 = humanize.toFileSize(123456789, 4);  //result2 = 117.7376 MB

####Angular Filter

$filter('humanize')(BYTE_SIZE, 'filesize', [DECIMAL_PLACE])

<span>{{BYTE_SIZE | humanize : 'filesize' : [DECIMAL_PLACE]}}</span>

Eg

angular.module('app').controller('AppController', ['dependancy', function(dependancy){
    var value = 123456789
    var result1 = $filter('humanize')(value, 'filesize')     //result1 = 117.74 MB
    var result2 = $filter('humanize')(value, 'filesize', 4)  //result2 = 117.7376 MB
}])

<span>{{filesize | humanize : 'filesize'}}</span>      <!-- <span>117.74 MB</span> -->
<span>{{filesize | humanize : 'filesize' : 4}}</span>  <!-- <span>117.7376 MB</span> -->

###Ordinalize

Ordinalize numbers

var result = humanize.toOrdinal(NUMBER)

Eg

var result1 = humanize.toOrdinal(1)     //result1 = 1st
var result2 = humanize.toOrdinal(2)     //result2 = 2nd
var result3 = humanize.toOrdinal(3)     //result3 = 3rd
var result4 = humanize.toOrdinal(4)     //result3 = 4th

####Angular Filter

$filter('humanize')(NUMBER, 'ordinal')

<span>{{NUMBER | humanize : 'ordinal'}}</span>

Eg

angular.module("app").controller("AppController", ["dependancy", function(dependancy){
    var value = 2
    var result1 = $filter('humanize')(value, 'ordinal')     //result1 = 2nd
}])

<span>{{value | humanize : 'ordinal'}}</span>      <!-- <span>2nd</span> -->

###Pluralize

Pluralize any string

var result = humanize.pluralize(STRING, [IS_KNOWN_SINGULAR])

Eg

var result1 = humanize.pluralize('user')     //result1 = users
var result2 = humanize.pluralize('man')      //result2 = men
var result3 = humanize.pluralize('Man')      //result3 = Men

####Angular Filter

$filter('humanize')(STRING, 'pluralize')

<span>{{STRING | humanize : 'pluralize'}}</span>

Eg

angular.module('app').controller('AppController', ['dependancy', function(dependancy){
    var value = 'man'
    var result1 = $filter('humanize')(value, 'pluralize')     //result1 = men
}])

<span>{{value | humanize : 'pluralize'}}</span>      <!-- <span>men</span> -->

###Singularize

Singularize any string

var result = humanize.singularize(STRING, [IS_KNOWN_PLURAL])

Eg

var result1 = humanize.singularize('users')    //result1 = user
var result2 = humanize.singularize('men')      //result2 = man
var result3 = humanize.singularize('Men')      //result3 = Man

####Angular Filter

$filter('humanize')(STRING, 'singularize')

<span>{{STRING | humanize : 'singularize'}}</span>

Eg

angular.module('app').controller('AppController', ['dependancy', function(dependancy){
    var value = 'men'
    var result1 = $filter('humanize')(value, 'singularize')     //result1 = man
}])

<span>{{value | humanize : 'singularize'}}</span>      <!-- <span>man</span> -->