A collection of the String Object methods and functions.

• MDN String

Returns the passed parameter as a String.

String.convert(arg);

1. arg - (mixed) The argument to return as a string.

• (string) The argument as a string.

String.convert(2); // returns '2'
String.convert(true); // returns 'true'

Generates a unique ID

String.uniqueID();

• (string) A unique ID.

String.uniqueID();

Searches for a match between the string and a regular expression. For more information see MDN Regexp:test.

myString.test(regex[, params]);

1. regex - (mixed) The string or regular expression you want to match the string with.
2. params - (string, optional) If first parameter is a string, any parameters you want to pass to the regular expression ('g' has no effect).

• (boolean) true, if a match for the regular expression is found in this string.
• (boolean) false if is not found

'I like cookies'.test('cookie'); // returns true
'I like cookies'.test('COOKIE', 'i'); // returns true (ignore case)
'I like cookies'.test('cake'); // returns false

• MDN Regular Expressions

Checks to see if the string passed in is contained in this string. If the position parameter is passed, it will only check for the string from that point.

myString.contains(string[, position]);

1. string - (string) The string to search for.
2. position - (number, optional) Position in the string to begin searching for string, defaults to 0.

• (boolean) true if the string is contained in this string
• (boolean) false if not.

'a bc'.contains('bc'); // returns true
'abc'.contains('b', 1); // returns true
'abc'.contains('b', 2); // returns false

• MDN String:indexOf
• MDN String:contains

Since MooTools 1.5 the second parameter changed from separator to position so it conforms the ES6 specification. If using the 1.4 compatibility layer, this method will be overwritten to have the old behavior.

Trims the leading and trailing spaces off a string.

myString.trim();

• (string) The trimmed string.

'    i like cookies     '.trim(); // returns 'i like cookies'

• MDN String:trim

Removes all extraneous whitespace from a string and trims it (String:trim).

myString.clean();

• (string) The cleaned string.

' i      like     cookies      \n\n'.clean(); // returns 'i like cookies'

Converts a hyphenated string to a camelcased string.

myString.camelCase();

• (string) The camelcased string.

'I-like-cookies'.camelCase(); // returns 'ILikeCookies'

Converts a camelcased string to a hyphenated string.

myString.hyphenate();

• (string) The hyphenated string.

'ILikeCookies'.hyphenate(); // returns '-i-like-cookies'

Converts the first letter of each word in a string to uppercase.

myString.capitalize();

• (string) The capitalized string.

'i like cookies'.capitalize(); // returns 'I Like Cookies'

Escapes all regular expression characters from the string.

myString.escapeRegExp();

• (string) The escaped string.

'animals.sheep[1]'.escapeRegExp(); // returns 'animals\.sheep\[1\]'

Parses this string and returns a number of the specified radix or base.

myString.toInt([base]);

1. base - (number, optional) The base to use (defaults to 10).

• (number) The number.
• (NaN) If the string is not numeric, returns NaN.

'4em'.toInt(); // returns 4
'10px'.toInt(); // returns 10

• MDN parseInt

Parses this string and returns a floating point number.

myString.toFloat();

• (number) The float.
• (NaN) If the string is not numeric, returns NaN.

'95.25%'.toFloat(); // returns 95.25
    '10.848'.toFloat(); // returns 10.848

• MDN parseFloat

Converts a hexadecimal color value to RGB. Input string must be in one of the following hexadecimal color formats (with or without the hash). '#ffffff', #fff', 'ffffff', or 'fff'

myString.hexToRgb([array]);

1. array - (boolean, optional) If true is passed, will output an array (e.g. [255, 51, 0]) instead of a string (e.g. 'rgb(255, 51, 0)').

• (string) A string representing the color in RGB.
• (array) If the array flag is set, an array will be returned instead.

'#123'.hexToRgb(); // returns 'rgb(17, 34, 51)'
'112233'.hexToRgb(); // returns 'rgb(17, 34, 51)'
'#112233'.hexToRgb(true); // returns [17, 34, 51]

Converts an RGB color value to hexadecimal. Input string must be in one of the following RGB color formats. 'rgb(255, 255, 255)', or 'rgba(255, 255, 255, 1)'

myString.rgbToHex([array]);

1. array - (boolean, optional) If true is passed, will output an array (e.g. ['ff', '33', '00']) instead of a string (e.g. '#ff3300').

• (string) A string representing the color in hexadecimal, or transparent if the fourth value of rgba in the input string is 0.
• (array) If the array flag is set, an array will be returned instead.

'rgb(17, 34, 51)'.rgbToHex(); // returns '#112233'
'rgb(17, 34, 51)'.rgbToHex(true); // returns ['11', '22', '33']
'rgba(17, 34, 51, 0)'.rgbToHex(); // returns 'transparent'

• Array:rgbToHex

Substitutes keywords in a string using an object/array. Removes undefined keywords and ignores escaped keywords.

myString.substitute(object[, regexp]);

1. object - (mixed) The key/value pairs used to substitute a string.
2. regexp - (regexp, optional) The regexp pattern to be used in the string keywords, with global flag. Defaults to /\?{([^}]+)}/g .

• (string) - The substituted string.

var myString = '{subject} is {property_1} and {property_2}.';
var myObject = {subject: 'Jack Bauer', property_1: 'our lord', property_2: 'saviour'};
myString.substitute(myObject); // returns Jack Bauer is our lord and saviour

Strips the String of its <script> tags and anything in between them.

myString.stripScripts([evaluate]);

1. evaluate - (boolean, optional) If true is passed, the scripts within the String will be evaluated.

• (string) - The String without the stripped scripts.

var myString = "<script>alert('Hello')</script>Hello, World.";
myString.stripScripts(); // returns 'Hello, World.'
myString.stripScripts(true); // alerts 'Hello', then returns 'Hello, World.'