Skip to content package
inflected v2.0.3 A port of ActiveSupport's inflector to Node.js
node any 0 deps esm cjs open source
overview readme
license MIT
deps 0
unpacked Unknown
files Unknown
node any $ npm install inflected@2.0.3n npmREADME GitHub-flavored package documentation.
downloads Across all versions, last 30 days.
2,228,068 weekly -3.1%
8,283,455 in 30 days
Oct 16 → Nov 14 hover or arrows
compatibility Runtime metadata.
keywords Tagged topics.
inflector inflection pluralize singularize camelize titleize tableize humanize capitalize constantify dasherize ordinalize
versions Latest published Sep 14, 2020
maintainers Registry package owners.
install size Estimated unpacked size across 1 packages.
78.6 kB
Includes dependencies.
A port of ActiveSupport's inflector to Node.js. Also usable in the browser.
Installation % npm install inflected copy The UMD build is also available on unpkg , adding a Inflector object to the global scope.
< script src = "https://unpkg.com/inflected/dist/umd/inflected.min.js" ></ script > copy
Usage The module exports an object with several utility functions.
var Inflector = require ( 'inflected' );
Inflector. pluralize ( 'Category' ) // => 'Categories' copy If using ES modules, you can cherry-pick only the functions you're interested in:
import { pluralize } from 'inflected' ;
pluralize ( 'Category' ) // => 'Categories' copy Here is the complete API reference:
Inflector.pluralize string pluralize (string word[, string locale]) copy Returns the plural form of the word in the string.
If passed an optional locale parameter, the word will be pluralized using rules defined for that language. By default, this parameter is set to "en".
Inflector. pluralize ( 'post' ) // => 'posts'
Inflector. pluralize ( 'octopus' ) // => 'octopi'
Inflector. pluralize ( 'sheep' ) // => 'sheep'
Inflector. pluralize ( 'words' ) // => 'words'
Inflector. pluralize ( 'CamelOctopus' ) // => 'CamelOctopi'
Inflector. pluralize ( 'ley' , 'es' ) // => 'leyes' copy
Inflector.singularize string singularize (string word[, string locale]) copy The reverse of pluralize, returns the singular form of a word in a string.
If passed an optional locale parameter, the word will be singularized using rules defined for that language. By default, this parameter is set to "en".
Inflector. singularize ( 'posts' ) // => 'post'
Inflector. singularize ( 'octopi' ) // => 'octopus'
Inflector. singularize ( 'sheep' ) // => 'sheep'
Inflector. singularize ( 'word' ) // => 'word'
Inflector. singularize ( 'CamelOctopi' ) // => 'CamelOctopus'
Inflector. singularize ( 'leyes' , 'es' ) // => 'ley' copy
Inflector.camelize string camelize (string term[, boolean uppercaseFirstLetter]) copy By default, camelize converts strings to UpperCamelCase. If the second argument is set to false then camelize produces lowerCamelCase.
Inflector. camelize ( 'foo_bar' ) // => 'FooBar'
Inflector. camelize ( 'foo_bar' , false ) // => 'fooBar' copy As a rule of thumb you can think of camelize as the inverse of underscore, though there are cases where that does not hold:
Inflector. camelize (Inflector. underscore ( 'SSLError' )) // => 'SslError' copy
Inflector.underscore string underscore (string camelCasedWord) copy Makes an underscored, lowercase form from the expression in the string.
Inflector. underscore ( 'FooBar' ) // => 'foo_bar' copy As a rule of thumb you can think of underscore as the inverse of camelize, though there are cases where that does not hold:
Inflector. camelize (Inflector. underscore ( 'SSLError' )) // => 'SslError' copy
Inflector.humanize string humanize (string lowerCaseAndUnderscoredWord[, object options]) copy Capitalizes the first word, turns underscores into spaces, and strips a trailing "_id" if present.
Like titleize, this is meant for creating pretty output.
The capitalization of the first word can be turned off by setting the capitalize option key to false. By default, this option is true.
Inflector. humanize ( 'employee_salary' ) // => 'Employee salary'
Inflector. humanize ( 'author_id' ) // => 'Author'
Inflector. humanize ( 'author_id' , { capitalize: false }) // => 'author' copy
Inflector.titleize string titleize (string sentence) copy Capitalizes all the words and replaces some characters in the string to create a nicer looking title. titleize is meant for creating pretty output.
Inflector. titleize ( 'man from the boondocks' ) // => 'Man From The Boondocks'
Inflector. titleize ( 'x-men: the last stand' ) // => 'X Men: The Last Stand'
Inflector. titleize ( 'TheManWithoutAPast' ) // => 'The Man Without A Past'
Inflector. titleize ( 'raiders_of_the_lost_ark' ) // => 'Raiders Of The Lost Ark' copy
Inflector.tableize string tableize (string className) copy Create the name of a table like Rails does for models to table names. This method uses the pluralize method on the last word in the string.
Inflector. tableize ( 'RawScaledScorer' ) // => 'raw_scaled_scorers'
Inflector. tableize ( 'egg_and_ham' ) // => 'egg_and_hams'
Inflector. tableize ( 'fancyCategory' ) // => 'fancy_categories' copy
Inflector.classify string classify (string tableName) copy Create a class name from a plural table name like Rails does for table names to models.
Inflector. classify ( 'egg_and_hams' ) // => 'EggAndHam'
Inflector. classify ( 'posts' ) // => 'Post' copy Singular names are not handled correctly:
Inflector. classify ( 'business' ) // => 'Busines' copy
Inflector.dasherize string dasherize (string underscoredWord) copy Replaces underscores with dashes in the string.
Inflector. dasherize ( 'puni_puni' ) // => 'puni-puni' copy
Inflector.foreignKey string foreignKey (string className[, boolean separateClassNameAndIdWithUnderscore]) copy Creates a foreign key name from a class name. separateClassNameAndIdWithUnderscore sets whether the method should put "_" between the name and "id" (default: true).
Inflector. foreignKey ( 'Message' ) // => 'message_id'
Inflector. foreignKey ( 'Message' , false ) // => 'messageid' copy
Inflector.ordinal string ordinal (object number) copy Returns the suffix that should be added to a number to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
Inflector. ordinal ( 1 ) // => 'st'
Inflector. ordinal ( 2 ) // => 'nd'
Inflector. ordinal ( 1002 ) // => 'nd'
Inflector. ordinal ( 1003 ) // => 'rd'
Inflector. ordinal ( - 11 ) // => 'th'
Inflector. ordinal ( - 1021 ) // => 'st' copy
Inflector.ordinalize string ordinalize (object number) copy Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
Inflector. ordinalize ( 1 ) // => '1st'
Inflector. ordinalize ( 2 ) // => '2nd'
Inflector. ordinalize ( 1002 ) // => '1002nd'
Inflector. ordinalize ( 1003 ) // => '1003rd'
Inflector. ordinalize ( - 11 ) // => '-11th'
Inflector. ordinalize ( - 1021 ) // => '-1021st' copy
Inflector.inflections Inflections inflections ([string locale])
inflections ([string locale], [ function (Inflections) fn ]) copy A singleton instance of the internal Inflections class is yielded by this function, which can then be used to specify additional inflection rules. If passed an optional locale, rules for other languages can be specified. The default locale is "en". Only rules for English are provided by this library.
Inflector. inflections ( 'en' , function (inflect) {
inflect. plural ( /^(ox)$/ i , '$1$2en' );
inflect.singular /^ (ox)en / i, '$1' );
inflect. irregular ( 'octopus' , 'octopi' );
inflect. uncountable ( 'equipment' , 'snow' );
}); copy New rules are added at the top. So in the example above, the irregular rule for octopus will now be the first of the pluralization and singularization rules that is run. This guarantees that your rules run before any of the rules that may already have been loaded.
Inflector.transliterate string transliterate (string sentence[, object options]) copy Replaces non-ASCII characters with an ASCII approximation, or if none exists, a replacement character which defaults to "?".
Inflector. transliterate ( 'Ærøskøbing' ) // => 'AEroskobing' copy Default approximations are provided for Western/Latin characters, e.g, "ø", "ñ", "é", "ß", etc.
This method is I18n-aware, so you can set up custom approximations for a locale. This can be useful, for example, to transliterate German's "ü" and "ö" to "ue" and "oe", or to add support for transliterating Russian to ASCII.
In order to make your custom transliterations available, you must set them using the approximate helper function:
Inflector. transliterations ( 'de' , function (t) {
t. approximate ( 'ü' , 'ue' );
t. approximate ( 'ö' , 'oe' );
}); copy Now you can have different transliterations for each locale:
Inflector. transliterate ( 'Jürgen' ) // => 'Jurgen'
Inflector. transliterate ( 'Jürgen' , { locale: 'de' }) // => 'Juergen' copy
Inflector.parameterize string parameterize (string sentence[, object options]) copy Replaces special characters in a string so that it may be used as part of a 'pretty' URL.
Inflector. parameterize ( 'Donald E. Knuth' ) // => 'donald-e-knuth'
Inflector. parameterize ( 'Donald E. Knuth' , { separator: '+' }) // => 'donald+e+knuth' copy As of v2.1, there's also a preserveCase option:
Inflector. parameterize ( 'Donald E. Knuth' , { preserveCase: true }) // => 'Donald+E+Knuth' copy
Inflector.constantify string constantify (string words) copy Converts words (camelCased, under_scored, or dasherized) to CONSTANT_CASE.
Inflector. constantify ( 'bankAccount' ) // => 'BANK_ACCOUNT'
Inflector. constantify ( 'bank-account' ) // => 'BANK_ACCOUNT'
Inflector. constantify ( 'bank_account' ) // => 'BANK_ACCOUNT'
Inflector. constantify ( 'Bank Account' ) // => 'BANK_ACCOUNT' copy
Contributing
Fork the repo and make install.
Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: make test.
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or are fixing a bug, we need a test!
Make the test pass.
Push to your fork and submit a pull request.
Licence Released under The MIT License.