Technology moves fast! ⚡ Don't get left behind.🚶 Subscribe to our mailing list to keep up with latest and greatest in open source projects! 🏆


Subscribe to our mailing list

humanize

A simple utility library for making the web more humane. #hubspot-open-source

Subscribe to updates I use humanize


Statistics on humanize

Number of watchers on Github 716
Number of open issues 19
Average time to close an issue 2 months
Main language CoffeeScript
Average time to merge a PR 4 days
Open pull requests 14+
Closed pull requests 7+
Last commit almost 3 years ago
Repo Created about 6 years ago
Repo Last Updated about 1 year ago
Size 706 KB
Organization / Authorhubspot
Latest Releasev1.5.0
Contributors9
Page Updated
Do you use humanize? Leave a review!
View open issues (19)
View humanize activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating humanize for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

Humanize Plus

npm version build status npm downloads

A simple utility library for making the web more humane.

Getting Started

Humanize Plus is available via node package manager.

npm install humanize-plus

Or download the minified version or the full version.

In your web page:

<script src="public/humanize.min.js"></script>
<script>
var capitalized = Humanize.capitalize("ten tiny ducklings.")
// "Ten tiny ducklings."
</script>

In your node package.json:

"dependencies": {
  "humanize-plus": "^1.7.0"
}

For recent changes, see the changelog.

API Methods

Numbers

formatNumber

Formats a number to a human-readable string. Localize by overriding the precision, thousand and decimal arguments.

Humanize.formatNumber(123456789, 2)
// "123,456,789.00"
intComma

Converts an integer to a string containing commas every three digits.

Humanize.intComma(123456789)
// "123,456,789"
intcomma - DEPRECATED - This method will not be present in the next major version.

Alias for intComma

intword - DEPRECATED - This method will not be present in the next major version.

Converts a large integer to a friendly text representation. This method is now a thin wrapper around compactInteger

Humanize.intword(num, ch, de) === Humanize.compactInteger(num, de)

Humanize.intword(123456789, 'nopnopnopnop', 1)
// "123.5M"

Humanize.intword(123456789, 'this is a nop', 3)
// "123.457M"

Humanize.intword(10, 'still a nop', 1)
// "10"
compactInteger

Converts an integer into its most compact representation. Decimal precision is ignored for all integers, n, such that abs(n) < 1000.

Humanize.compactInteger(123456789, 1)
// "123.5M"

// Switch to scientific notation for trillons, because no one knows those abbreviations.
Humanize.compactInteger(-7832186132456328967, 4)
// "-7.8322x10^18"

Humanize.compactInteger(-100, 2)
// "-100"
boundedNumber

Bounds a value from above. Modified values have customizable ending strings ('+' by default)

Humanize.boundedNumber(110, 100)
// "100+"

Humanize.boundedNumber(50, 100)
// "50"
truncatenumber - DEPRECATED - This method will not be present in the next major version.

Alias for boundedNumber

ordinal

Converts an integer to its ordinal as a string.

Humanize.ordinal(22)
// "22nd"
times

Interprets numbers as occurences. Also accepts an optional array/map of overrides.

for (i=0; i<5; i++) {
  Humanize.times(i, {"4": "too many"});
  // Bonus!
  if (i === 1) {
    Humanize.times(1.1);
  }
}
// never
// once
// 1.1 times
// twice
// 3 times
// too many times
pace

Matches a pace (value and interval) with a logical time frame. Very useful for slow paces.

second = 1000
week = 6.048e8
decade = 3.156e11

Humanize.pace(1.5, second, "heartbeat")
// Approximately 2 heartbeats per second

Humanize.pace(4, week)
// Approximately 4 times per week

Humanize.pace(1, decade, "life crisis")
// Less than 1 life crisis per week
fileSize

Formats the value like a 'human-readable' file size (i.e. '13 KB', '4.1 MB', '102 bytes', etc).

Humanize.fileSize(1024 * 20)
// "20 Kb"

Humanize.fileSize(1024 * 2000)
// "1.95 Mb"

Humanize.fileSize(Math.pow(1000, 4))
// "931.32 Gb"
filesize - DEPRECATED - This method will not be present in the next major version.

Alias for fileSize

pluralize

Returns the plural version of a given word if the value is not 1. The default suffix is 's'.

Humanize.pluralize(1, "duck")
// "duck"

Humanize.pluralize(3, "duck")
// "ducks"

Humanize.pluralize(3, "duck", "duckies")
// "duckies"

Strings

truncate

Truncates a string if it is longer than the specified number of characters. Truncated strings will end with a translatable ellipsis sequence ("").

Humanize.truncate('long text is good for you')
// "long text is good for you"

Humanize.truncate('long text is good for you', 19)
// "long text is goo..."

Humanize.truncate('long text is good for you', 19, '... etc')
// "long text is... etc"
truncateWords

Truncates a string after a certain number of words.

Humanize.truncateWords('long text is good for you', 5)
// "long text is good for ..."
truncatewords - DEPRECATED - This method will not be present in the next major version.

Alias for truncateWords

nl2br and br2nl

Flexible conversion of <br/> tags to newlines and vice versa.

// Use your imagination
capitalize

Capitalizes the first letter in a string, optionally downcasing the tail.

Humanize.capitalize("some boring string")
// "Some boring string"

Humanize.capitalize("wHoOaA!")
// "WHoOaA!"

Humanize.capitalize("wHoOaA!", true)
// "Whooaa!"
capitalizeAll

Captializes the first letter of every word in a string.

Humanize.capitalizeAll("some boring string")
// "Some Boring String"
titleCase

Intelligently capitalizes eligible words in a string and normalizes internal whitespace.

Humanize.titleCase("some of a boring string")
// "Some of a Boring String"

Humanize.titleCase("cool the          iTunes cake, O'Malley!")
// "Cool the iTunes Cake, O'Malley!"
titlecase - DEPRECATED - This method will not be present in the next major version.

Alias for titleCase

Arrays

oxford

Converts a list of items to a human readable string with an optional limit.

items = ['apple', 'orange', 'banana', 'pear', 'pineapple']

Humanize.oxford(items)
// "apple, orange, banana, pear, and pineapple"

Humanize.oxford(items, 3)
// "apple, orange, banana, and 2 others"

// Pluralizes properly too!
Humanize.oxford(items, 4)
// "apple, orange, banana, pear, and 1 other"

Humanize.oxford(items, 3, "and some other fruits")
// "apple, orange, banana, and some other fruits"
frequency

Describes how many times an item appears in a list

aznPics = [
  'http://24.media.tumblr.com/77082543cb69af56ede38a0cdb2511d0/tumblr_mh96olWPLv1r8k4ywo1_1280.jpg',
  'http://25.media.tumblr.com/3e2d318be34d5ef8f86a612cd1d795ff/tumblr_mhbhb96t3z1r8k4ywo1_1280.jpg',
  'http://24.media.tumblr.com/8c5a052e33c27c784514e1b124b383a1/tumblr_mhexaqrk0w1r8k4ywo1_1280.jpg'
]
bigfootPics = []

"Instagrammers " + Humanize.frequency(aznPics, "took pictures of food")
// "Instagrammers took pictures of food 3 times"

"Bigfoot " + Humanize.frequency(bigfootPics, "took pictures of food")
// "Bigfoot never took pictures of food"

Utility methods

toFixed

Fixes binary rounding issues (eg. (0.615).toFixed(2) === 0.61).

Humanize.toFixed(0.615, 2)
// "0.62"
normalizePrecision

Ensures precision value is a positive integer.

Humanize.normalizePrecision(-232.231)
// 232

Important notes

Please don't edit files in the dist subdirectory as they are generated through compilation. You'll find source code in the src subdirectory!

Compiling

npm run install && npm run build

And that's it!

The project will compile the CoffeeScript files into the dist subdirectory.

Testing

npm run test

License

Copyright (c) 2013-2016 HubSpotDev Licensed under the MIT license.

humanize open issues Ask a question     (View All Issues)
  • over 2 years Should check for 'undefined' or `null` parameter values
  • over 2 years Humanize.truncateWords returns null when input has less number of words
  • over 2 years Error in Firefox
  • over 2 years TypeScript definitions
  • almost 3 years Rewrite functions as ES6 modules
humanize open pull requests (View All Pulls)
  • KB should be kB
  • Added #truncateNearestWord
  • update some versions
  • Add percision parameter to fileSize
  • fix #67
  • Make it possible to customize the arguments of formatNumber
  • Add optional conjunction parameter to oxford
  • Introduction rewrite
  • Using main from dist folder; updated version.
  • Have ordinal return 0th instead of 0
  • Fix "SyntaxError: missing = in const declaration" in Firefox. fixes #83
  • null issue with truncateWords fixes #84, added tests
  • update readme to reflect coffeescript was replaced with ecmascript
  • Add Typescript Definition
humanize questions on Stackoverflow (View All Questions)
  • Is it possible to Humanize TimeSpan to years with Humanizer?
  • Django humanize outside of template?
  • How to humanize duration in angularjs?
  • Humanize uppercase name with hyphenated last name
  • Humanize a string in JavaScript
  • How can I format and humanize a video chunk duration using moment.js?
  • How can I humanize this complete duration in moment.js / javascript
  • Moment.js : change the default humanize() behavior
  • Humanize numbers with python
  • Using Play framework with Scala, how can I humanize a Json Validation message?
  • humanize in django/python, how to translate
  • How to humanize child input in Rails?
  • javascript custom humanize filter
  • How do i humanize variables like A1+ and A1- (list of blood groups)
  • Is there a way to have a custom humanize result for certain symbols?
  • How to display "x days ago" type time using Humanize in Django template?
  • Custom filesize format with Python Humanize?
  • Rails how to call helpers such as .humanize on an attribute of collection_select
  • humanize "naturaltime" issue
  • Backbone.js equivalent of django humanize - int.word and int.comma - using underscore.string
  • Getting django's humanize working on App Engine
  • Inflector::humanize($key) converts Date of joining TO Date Of Joining
  • Rails - Humanize attribute globally
  • Rails datetime interval humanize
  • "TemplateSyntaxError: 'humanize' is not a valid tag library:" in DJango
  • Humanize rails select helper
  • Humanize attributes with Mongoid?
  • Is there an easy way to humanize string in collection_select?
  • Does rails have an opposite of 'humanize' for strings?
  • How to display "This many months ago" in Django using Humanize?
humanize list of languages used
humanize latest release notes
v1.5.0 v1.5.0

Drop support for node v0.6 and update compactInteger()

v1.4.2 v1.4.2

Couple of bug fixes and additions, primarily for our node.js friends. Also starting to deprecate a couple of methods in preparation for v2.

Other projects in CoffeeScript