strings
Provides some helper functions to work with strings. This list is also added to the available filters inside your EJS templates.
You can access these tools on the Gluegun toolbox, via const { strings } = require('gluegun'), or directly via const { strings } = require('gluegun/strings').
Utility
identity
Returns the input as output. Great for functional programming like sorting or fallbacks.
** arguments **
valuecan beanytype which becomes the return value of this function.
** returns **
- the
valuethat was passed in
identity('hello') // hello
identity(4) // 4
identity([1, 'a']) // [1, 'a']
isBlank
Determines if a string is empty by trimming it first.
isBlank('') // true
isBlank(' ') // true
isNotString
Tests a value to see if it is not a string.
isNotString(true) // true
isNotString(null) // true
isNotString(undefined) // true
isNotString(123) // true
isNotString('hi') // false
Growing
pad
Centers a string to a given length.
pad('hola', 20) // ' hola '
padStart
Fills a string to a certain length by adding characters to the front.
padStart('hello', 10, '.') // '.....hello'
padEnd
Fills a string to a certain length by adding characters to the end.
padEnd('hello', 10, '!') // 'hello!!!!!'
repeat
Repeats a string a number of times to make a pattern.
repeat('x', 3) // 'xxx'
repeat('xo', 3) // 'xoxoxo'
Shrinking
trim
Strips white space from both the start and end of a string, but not the middle.
trim(' kevin spacey ') // 'kevin spacey'
trimStart
Strips white space from the start of a string.
trimStart(' hi ') // 'hi '
trimEnd
Strips white space from the end of a string.
trimEnd('windows!\r\n') // 'windows!'
Case Conversion
camelCase
Capitalizes the first letter of each word it smashes together on word boundaries. The first letter becomes lowercase. Puncuation gets dropped.
Great for assembling javascript variable names.
camelCase('hello there') // 'helloThere'
camelCase('Hello there') // 'helloThere'
camelCase('abc123') // 'abc123'
camelCase('Y M C A') // 'yMCA'
camelCase('Welcome to ZOMBO.com') // 'welcomeToZomboCom'
camelCase('XMLHttpRequest is strange.') // 'xmlHttpRequestIsStrange'
camelCase('OSnap') // 'oSnap'
camelCase('this.is.sparta!') // 'thisIsSparta'
kebabCase
Skewers words by placing - characters between them and downcasing.
kebabCase('hello there') // 'hello-there'
kebabCase('Hello there') // 'hello-there'
kebabCase('abc123') // 'abc-123'
kebabCase('Y M C A') // 'y-m-c-a'
kebabCase('Welcome to ZOMBO.com') // 'welcome-to-zombo-com'
kebabCase('XMLHttpRequest is strange.') // 'xml-http-request-is-strange'
kebabCase('OSnap') // 'o-snap'
kebabCase('this.is.sparta!') // 'this-is-sparta'
snakeCase
Joins words together with underscores after splitting up into word boundaries.
Great for ruby and some apis.
snakeCase('hello there') // 'hello_there'
snakeCase('Hello there') // 'hello_there'
snakeCase('abc123') // 'abc_123'
snakeCase('Y M C A') // 'y_m_c_a'
snakeCase('Welcome to ZOMBO.com') // 'welcome_to_zombo_com'
snakeCase('XMLHttpRequest is strange.') // 'xml_http_request_is_strange'
snakeCase('OSnap') // 'o_snap'
snakeCase('this.is.sparta!') // 'this_is_sparta'
upperCase
A staple in every troll's toolbelt, this makes everything uppercase.
upperCase('hello there') // 'HELLO THERE'
upperCase('Hello there') // 'HELLO THERE'
upperCase('abc123') // 'ABC 123'
upperCase('Y M C A') // 'Y M C A'
upperCase('Welcome to ZOMBO.com') // 'WELCOME TO ZOMBO COM'
upperCase('XMLHttpRequest is strange.') // 'XML HTTP REQUEST IS STRANGE'
upperCase('OSnap') // 'O SNAP'
upperCase('this.is.sparta!') // 'THIS IS SPARTA'
lowerCase
This makes everything lower case.
lowerCase('hello there') // 'hello there'
lowerCase('Hello there') // 'hello there'
lowerCase('abc123') // 'abc 123'
lowerCase('Y M C A') // 'y m c a'
lowerCase('Welcome to ZOMBO.com') // 'welcome to zombo com'
lowerCase('XMLHttpRequest is strange.') // 'xml http request is strange'
lowerCase('OSnap') // 'o snap'
lowerCase('this.is.sparta!') // 'this is sparta'
startCase
Uppercases the first letter of each word after dicing up on word boundaries.
startCase('hello there') // 'Hello There'
startCase('Hello there') // 'Hello There'
startCase('abc123') // 'Abc 123'
startCase('Y M C A') // 'Y M C A'
startCase('Welcome to ZOMBO.com') // 'Welcome To ZOMBO Com'
startCase('XMLHttpRequest is strange.') // 'XML Http Request Is Strange'
startCase('OSnap') // 'O Snap'
startCase('this.is.sparta!') // 'This Is Sparta'
upperFirst
Uppercases the first letter of the string.
upperFirst('hello there') // 'Hello there'
upperFirst('Hello there') // 'Hello there'
upperFirst('abc123') // 'Abc123'
upperFirst('Y M C A') // 'Y M C A'
upperFirst('Welcome to ZOMBO.com') // 'Welcome to ZOMBO.com'
upperFirst('XMLHttpRequest is strange.') // 'XMLHttpRequest is strange.'
upperFirst('OSnap') // 'OSnap'
upperFirst('this.is.sparta!') // 'This.is.sparta!'
lowerFirst
Lowercases the first letter of the string.
lowerFirst('hello there') // 'hello there'
lowerFirst('Hello there') // 'hello there'
lowerFirst('abc123') // 'abc123'
lowerFirst('Y M C A') // 'y M C A'
lowerFirst('Welcome to ZOMBO.com') // 'welcome to ZOMBO.com'
lowerFirst('XMLHttpRequest is strange.') // 'xMLHttpRequest is strange.'
lowerFirst('OSnap') // 'oSnap'
lowerFirst('this.is.sparta!') // 'this.is.sparta!'
pascalCase
This is camelCase + upperFirst.
pascalCase('hello there') // 'HelloThere'
pascalCase('Hello there') // 'HelloThere'
pascalCase('abc123') // 'Abc123'
pascalCase('Y M C A') // 'YMCA'
pascalCase('Welcome to ZOMBO.com') // 'WelcomeToZomboCom'
pascalCase('XMLHttpRequest is strange.') // 'XmlHttpRequestIsStrange'
pascalCase('OSnap') // 'OSnap'
pascalCase('this.is.sparta!') // 'ThisIsSparta'
pluralize
Pluralize or singularize a word based on the passed in count.
pluralize('test', 1) // 'test'
pluralize('test', 5) // 'tests'
pluralize('test', 1, true) // '1 test'
pluralize('test', 5, true) // '5 tests'
plural
Converts a given singular word to plural.
plural('bug') // 'bugs'
plural('word') // 'words'
singular
Converts a given plural word to singular.
singular('bugs') // 'bug'
singular('words') // 'word'
isPlural
Checks if the give word is plural.
isPlural('bugs') // true
isPlural('bug') // false
isSingular
Checks if the give word is singular.
isSingular('bugs') // false
isSingular('bug') // true
addPluralRule
Adds a pluralization rule for the given singular word when calling plural.
addPluralRule('regex', 'regexii')
addPluralRule(/regex$/, 'regexii')
addSingularRule
Adds a pluralization rule for the given plural word when calling singular.
addSingularRule('regexii', 'regex')
addSingularRule(/regexii$/, 'regex')
addIrregularRule
Adds a pluralization rule for the given irregular word when calling plural.
addIrregularRule('octopus', 'octopodes')
addUncountableRule
Exempts the given uncountable word from pluralization so that calling plural or singular with that word will return the same word unchanged.
addUncountableRule('paper')