xtr.strings¶

appendIfMissing¶

appendIfMissing(str: String, suffix: String): String

Returns str, appended with suffix if it does not already end with suffix.

Example

xtr.strings.appendIfMissing('Hello', ' World')

'Hello World'

capitalize¶

capitalize(str: String): String

Returns the capitalized version of str, by capitalizing the first letter of every word.

Example

xtr.strings.capitalize('hello world')

'Hello World'

charCode¶

charCode(char: String): String

Returns the character-code for the given char.

Example

xtr.strings.charCode('*')

42

charCodeAt¶

charCodeAt(str: String, index: Number): String

Returns the character-code for the character at the given index in str.

Example

xtr.strings.charCodeAt('_*_', 1)

42

ofCharCode¶

ofCharCode(code: Number): String

Returns the character for the given character-code.

Example

xtr.strings.ofCharCode(42)

'*'

isAlpha¶

isAlpha(str: String): String

Returns true if the given str contains only alphabetic characters, otherwise false.

Example

xtr.strings.isAlpha('abcde')

true

isAlphanumeric¶

isAlphanumeric(str: String): String

Returns true if the given str contains only alphanumeric characters, otherwise false.

Example

xtr.strings.isAlphanumeric('a1b2cd3e4')

true

isLowerCase¶

isLowerCase(str: String): String

Returns true if the alphabetic characters in the given str are all lowercase, otherwise false.

Example

xtr.strings.isLowerCase('hello')

true

isNumeric¶

isNumeric(str: String): String

Returns true if the given str contains only numeric characters.

Example

xtr.strings.isNumeric('34634')

true

isUpperCase¶

isUpperCase(str: String): String

Returns true if the alphabetic characters in the given str are all uppercse, otherwise false.

Example

xtr.strings.isUpperCase('HELLO')

true

leftPad¶

leftPad(str: String, size: Number, char: String): String

Returns str prepended with enough repetitions of char required to meet the given size, otherwise returns str if its size is already equal or longer than size.

Example

xtr.strings.leftPad('Hello', 10, ' ')

'     Hello'

numOrdinalOf¶

numOrdinalOf(num: Number): String

Returns the numeric ordinal name for the given num.

Example

xtr.strings.numOrdinalOf(1)

'1st'

pluralize¶

pluralize(word: String): String

Returns the plural of the given word.

Example

xtr.strings.pluralize('car')

'cars'

prependIfMissing¶

prependIfMissing(str: String, prefix: String): String

Returns str, prepended with prefix if it does not already start with prefix.

Example

xtr.strings.prependIfMissing('World', 'Hello ')

'Hello World'

repeat¶

repeat(str: String, n: Number): String

Returns str repeated n times.

Example

xtr.strings.repeat('hey ', 2)

'hey hey '

rightPad¶

rightPad(str: String, size: Number, char: String): String

Returns str prepended with enough repetitions of char required to meet the given size, otherwise returns str if its size is already equal or longer than size.

Example

xtr.strings.rightPad('Hello', 10, ' ')

'Hello     '

singularize¶

singularize(word: String): String

Returns the singular of the given word.

Example

xtr.strings.singularize('cars')

'car'

substringAfter¶

substringAfter(str1: String, str2: String): String

Returns the contents of str1 after the first occurrence of str2, otherwise returns str1 if it does not contain str2.

Example

xtr.strings.substringAfter('!XHelloXWorldXAfter', 'X')

'HelloXWorldXAfter'

substringAfterLast¶

substringAfterLast(str1: String, str2: String): String

Returns the contents of str1 after the last occurrence of str2, otherwise returns str1 if it does not contain str2.

Example

xtr.strings.substringAfterLast('!XHelloXWorldXAfter', 'X')

'After'

substringBefore¶

substringBefore(str1: String, str2: String): String

Returns the contents of str1 before the first occurrence of str2, otherwise returns str1 if it does not contain str2.

Example

xtr.strings.substringBefore('!XHelloXWorldXAfter', 'X')

'!'

substringBeforeLast¶

substringBeforeLast(str1: String, str2: String): String

Returns the contents of str1 before the last occurrence of str2, otherwise returns str1 if it does not contain str2.

Example

xtr.strings.substringBeforeLast('!XHelloXWorldXAfter', 'X')

'!XHelloXWorld'

toCamelCase¶

toCamelCase(str: String): String

Returns the toCamelCased version of str, by removing all spaces and underscores, and capitalizing the first letter of every word after the first.

Example

xtr.strings.toCamelCase('Hello to_everyone')

'helloToEveryone'

toKebabCase¶

toKebabCase(str: String): String

Returns the kebab-case version of str, by changing alphabetic characters to lowercase, and replacing all spaces and underscores for dashes.

Example

xtr.strings.toKebabCase('Hello World_X')

'hello-world-x'

toSnakeCase¶

toSnakeCase(str: String): String

Returns the snake_case version of the given str, by prepending uppercase characters with an underscore, changing alphabetic characters to lowercase, and replacing all spaces for underscores.

Example

xtr.strings.toSnakeCase('Hello WorldX')

'hello_world_x'

unwrap¶

unwrap(str: String, wrap: String): String

Returns str without the given wrap as prefix and suffix, if found.

Example

xtr.strings.unwrap('_Hello, world!_', '_')

'Hello, world!'

wrap¶

wrap(str: String, wrap: String): String

Returns str, prepended and appended with wrap.

Example

xtr.strings.wrap('_Hello, world!', '_')

'__Hello, world!_'

wrapIfMissing¶

wrapIfMissing(str: String, wrap: String): String

Returns str, prepended and appended with wrap, if not found.

Example

xtr.strings.wrapIfMissing('_Hello, world!', '_')

'_Hello, world!_'