https://github.com/arjun-g/humanizejs
https://github.com/arjun-g/humanizejs
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/arjun-g/humanizejs
- Owner: arjun-g
- License: mit
- Created: 2016-02-22T17:40:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-03-28T19:29:45.000Z (about 9 years ago)
- Last Synced: 2025-03-02T05:09:38.647Z (2 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# humanizejs
[](https://gitter.im/arjun-g/humanizejs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://travis-ci.org/arjun-g/humanizejs)
##Getting started
###Bower
```bash
bower install humanizejs
```
```html
```
###NPM
```bash
npm install humanizejs
```
```javascript
var humanize = require('humanizejs')
```
###Angular
```javascript
angular.module('app', ['ngHumanize'])
```
##Usage
###File Size
Converts byte size to human readable string
```javascript
var result = humanize.toFileSize(BYTE_SIZE, [DECIMAL_PLACE]); //DECIMAL_PLACE defaults to 2.
```
**Eg**
```javascript
var result1 = humanize.toFileSize(123456789); //result1 = 117.74 MB
var result2 = humanize.toFileSize(123456789, 4); //result2 = 117.7376 MB
```
####Angular Filter
```javascript
$filter('humanize')(BYTE_SIZE, 'filesize', [DECIMAL_PLACE])
```
```html
{{BYTE_SIZE | humanize : 'filesize' : [DECIMAL_PLACE]}}
```
**Eg**
```javascript
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
}])
```
```html
{{filesize | humanize : 'filesize'}}
{{filesize | humanize : 'filesize' : 4}}
```
###Ordinalize
Ordinalize numbers
```javascript
var result = humanize.toOrdinal(NUMBER)
```
**Eg**
```javascript
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
```javascript
$filter('humanize')(NUMBER, 'ordinal')
```
```html
{{NUMBER | humanize : 'ordinal'}}
```
**Eg**
```javascript
angular.module("app").controller("AppController", ["dependancy", function(dependancy){
var value = 2
var result1 = $filter('humanize')(value, 'ordinal') //result1 = 2nd
}])
```
```html
{{value | humanize : 'ordinal'}}
```
###Pluralize
Pluralize any string
```javascript
var result = humanize.pluralize(STRING, [IS_KNOWN_SINGULAR])
```
**Eg**
```javascript
var result1 = humanize.pluralize('user') //result1 = users
var result2 = humanize.pluralize('man') //result2 = men
var result3 = humanize.pluralize('Man') //result3 = Men
```
####Angular Filter
```javascript
$filter('humanize')(STRING, 'pluralize')
```
```html
{{STRING | humanize : 'pluralize'}}
```
**Eg**
```javascript
angular.module('app').controller('AppController', ['dependancy', function(dependancy){
var value = 'man'
var result1 = $filter('humanize')(value, 'pluralize') //result1 = men
}])
```
```html
{{value | humanize : 'pluralize'}}
```
###Singularize
Singularize any string
```javascript
var result = humanize.singularize(STRING, [IS_KNOWN_PLURAL])
```
**Eg**
```javascript
var result1 = humanize.singularize('users') //result1 = user
var result2 = humanize.singularize('men') //result2 = man
var result3 = humanize.singularize('Men') //result3 = Man
```
####Angular Filter
```javascript
$filter('humanize')(STRING, 'singularize')
```
```html
{{STRING | humanize : 'singularize'}}
```
**Eg**
```javascript
angular.module('app').controller('AppController', ['dependancy', function(dependancy){
var value = 'men'
var result1 = $filter('humanize')(value, 'singularize') //result1 = man
}])
```
```html
{{value | humanize : 'singularize'}}
```
###Extend Prototype
Extends the primitive data types of javascript to have the above functions attached to them.
```javascript
humanize.extendPrototype()
```
**Eg**
```javascript
humanize.extendPrototype()
var size = 123456789;
var result1 = size.toFileSize(); //result1 = 117.74 MB
var result2 = size.toFileSize(4); //result2 = 117.7376 MB
var number = 10
var result3 = number.toOrdinal() //result3 = 10th
var string1 = "man"
var result4 = string1.pluralize() //result4 = men
var string2 = "Men"
var result5 = string2.singularize() //result5 = Man
```
###Build & Test
humanizejs requires gulp for building and karma for testing. Make sure these two are installed globally before building or testing.
```bash
npm install -g gulp
npm install -g karma
```
Start with installing all the required packages
```bash
npm install
```
####Build
```bash
gulp build
```
####Test
```bash
gulp test
```