goog.string Namespacegoog.string.Parser InterfaceAn interface for parsing strings into objects. @interface … more
goog.string.StringBuffer ClassUtility class to facilitate string concatenation. … more
goog.string.Stringifier InterfaceAn interface for serializing objects into strings. @interface … more
goog.string.Unicode EnumCommon Unicode string characters. … more
.buildString(var_args)Concatenates string expressions. This is useful since some browsers are very inefficient when it comes to using plus to concat strings. Be careful when using null and undefined here since these will not be included in the result. If you need to represent these be sure to cast the argument to a String first. For example:
buildString('a', 'b', 'c', 'd') -> 'abcd'
buildString(null, undefined) -> ''
var_args {...*}
string}
.canonicalizeNewlines(str)Replaces Windows and Mac new lines with unix style: \r or \r\n with \n.
str {string}
string}
.caseInsensitiveCompare(str1, str2)A string comparator that ignores case. -1 = str1 less than str2 0 = str1 equals str2 1 = str1 greater than str2
str1 {string}
str2 {string}
number}
.caseInsensitiveEndsWith(str, suffix)Case-insensitive suffix-checker.
str {string}
suffix {string}
boolean}
.caseInsensitiveStartsWith(str, prefix)Case-insensitive prefix-checker.
str {string}
prefix {string}
boolean}
.collapseBreakingSpaces(str)Removes the breaking spaces from the left and right of the string and collapses the sequences of breaking spaces in the middle into single spaces. The original and the result strings render the same way in HTML.
str {string}
string}
.collapseWhitespace(str)Converts multiple whitespace chars (spaces, non-breaking-spaces, new lines and tabs) to a single space, and strips leading and trailing whitespace.
str {string}
string}
.compareVersions(version1, version2)Compares two version numbers.
version1 {string|number}
version2 {string|number}
number}
.contains(s, ss)Checks whether a string contains a given substring.
s {string}
ss {string}
boolean}
.countOf(s, ss)Returns the non-overlapping occurrences of ss in s. If either s or ss evalutes to false, then returns zero.
s {string}
ss {string}
number}
.createUniqueString()Generates and returns a string which is unique in the current document. This is useful, for example, to create unique IDs for DOM elements.
string}
.endsWith(str, suffix)Fast suffix-checker.
str {string}
suffix {string}
boolean}
.escapeChar(c)Takes a character and returns the escaped string for that character. For example escapeChar(String.fromCharCode(15)) -> "\\x0E".
c {string}
string}
.escapeString(str)Takes a string and returns the escaped string for that character.
str {string}
string}
goog.string.format NamespacePerforms sprintf-like conversion, ie. puts the values in a template. DO NOT use it instead of built-in conversions in simple cases such as 'Cost: %.2f' as it would introduce unneccessary latency oposed to 'Cost: ' + cost.toFixed(2). … more
.getRandomString()Returns a string with at least 64-bits of randomness. Doesn't trust Javascript's random function entirely. Uses a combination of random and current timestamp, and then encodes the string in base-36 to make it shorter.
string}
.hashCode(str)String hash function similar to java.lang.String.hashCode(). The hash code for a string is computed as s[0] * 31 ^ (n - 1) + s[1] * 31 ^ (n - 2) + ... + s[n - 1], where s[i] is the ith character of the string and n is the length of the string. We mod the result to make it between 0 (inclusive) and 2^32 (exclusive).
str {string}
number}
goog.string.html Namespace.htmlEscape(str, opt_isLikelyToContainHtmlChars)Escape double quote '"' characters in addition to '&', '<', and '>' so that a string can be included in an HTML tag attribute value within double quotes. It should be noted that > doesn't need to be escaped for the HTML or XML to be valid, but it has been decided to escape it for consistency with other implementations. NOTE(user): HtmlEscape is often called during the generation of large blocks of HTML. Using statics for the regular expressions and strings is an optimization that can more than half the amount of time IE spends in this function for large apps, since strings and regexes both contribute to GC allocations. Testing for the presence of a character before escaping increases the number of function calls, but actually provides a speed increase for the average case -- since the average case often doesn't require the escaping of all 4 characters and indexOf() is much cheaper than replace(). The worst case does suffer slightly from the additional calls, therefore the opt_isLikelyToContainHtmlChars option has been included for situations where all 4 HTML entities are very likely to be present and need escaping. Some benchmarks (times tended to fluctuate +-0.05ms): FireFox IE6 (no chars / average (mix of cases) / all 4 chars) no checks 0.13 / 0.22 / 0.22 0.23 / 0.53 / 0.80 indexOf 0.08 / 0.17 / 0.26 0.22 / 0.54 / 0.84 indexOf + re test 0.07 / 0.17 / 0.28 0.19 / 0.50 / 0.85 An additional advantage of checking if replace actually needs to be called is a reduction in the number of object allocations, so as the size of the application grows the difference between the various methods would increase.
str {string}
opt_isLikelyToContainHtmlChars {boolean=}
string}
.isAlpha(str)Checks if a string contains all letters.
str {string}
boolean}
.isAlphaNumeric(str)Checks if a string contains only numbers or letters.
str {string}
boolean}
.isBreakingWhitespace(str)Checks if a string is all breaking whitespace.
str {string}
boolean}
.isEmpty(str)Checks if a string is empty or contains only whitespaces.
str {string}
boolean}
.isEmptySafe(str)Checks if a string is null, empty or contains only whitespaces.
str {*}
boolean}
.isNumeric(str)Checks if a string contains only numbers.
str {*}
boolean}
.isSpace(ch)Checks if a character is a space character.
ch {string}
boolean}
.isUnicodeChar(ch)Checks if a character is a valid unicode character.
ch {string}
boolean}
goog.string.linkify Namespace.makeSafe(obj)Returns a string representation of the given object, with null and undefined being returned as the empty string.
obj {*}
string}
.newLineToBr(str, opt_xml)Converts \n to
s or
s.
str {string}
opt_xml {boolean=}
string}
.normalizeSpaces(str)Normalizes spaces in a string, replacing all consecutive spaces and tabs with a single space. Replaces non-breaking space with a space.
str {string}
string}
.normalizeWhitespace(str)Normalizes whitespace in a string, replacing all whitespace chars with a space.
str {string}
string}
.numerateCompare(str1, str2)String comparison function that handles numbers in a way humans might expect. Using this function, the string "File 2.jpg" sorts before "File 10.jpg". The comparison is mostly case-insensitive, though strings that are identical except for case are sorted with the upper-case strings before lower-case. This comparison function is significantly slower (about 500x) than either the default or the case-insensitive compare. It should not be used in time-critical code, but should be fast enough to sort several hundred short strings (like filenames) with a reasonable delay.
str1 {string}
str2 {string}
number}
.padNumber(num, length, opt_precision)Pads number to given length and optionally rounds it to a given precision. For example:
padNumber(1.25, 2, 3) -> '01.250' padNumber(1.25, 2) -> '01.25' padNumber(1.25, 2, 1) -> '01.3' padNumber(1.25, 0) -> '1.25'
num {number}
length {number}
opt_precision {number=}
string}
.parseInt(value)Parse a string in decimal or hexidecimal ('0xFFFF') form. To parse a particular radix, please use parseInt(string, radix) directly. See https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/parseInt This is a wrapper for the built-in parseInt function that will only parse numbers as base 10 or base 16. Some JS implementations assume strings starting with "0" are intended to be octal. ES3 allowed but discouraged this behavior. ES5 forbids it. This function emulates the ES5 behavior. For more information, see Mozilla JS Reference: http://goo.gl/8RiFj
value {string|number|null|undefined}
number}
goog.string.path Namespace.quote(s)Encloses a string in double quotes and escapes characters so that the string is a valid JS string.
s {string}
string}
.regExpEscape(s)Escapes characters in the string that are not safe to use in a RegExp.
s {*}
string}
.remove(s, ss)Removes the first occurrence of a substring from a string.
s {string}
ss {string}
string}
.removeAll(s, ss)Removes all occurrences of a substring from a string.
s {string}
ss {string}
string}
.removeAt(s, index, stringLength)Removes a substring of a specified length at a specific index in a string.
s {string}
index {number}
stringLength {number}
string}
.repeat(string, length)Repeats a string n times.
string {string}
length {number}
string}
.startsWith(str, prefix)Fast prefix-checker.
str {string}
prefix {string}
boolean}
.stripNewlines(str)Takes a string and replaces newlines with a space. Multiple lines are replaced with a single space.
str {string}
string}
.stripQuotes(str, quoteChars)Strip quote characters around a string. The second argument is a string of characters to treat as quotes. This can be a single character or a string of multiple character and in that case each of those are treated as possible quote characters. For example:
goog.string.stripQuotes('"abc"', '"`') --> 'abc'
goog.string.stripQuotes('`abc`', '"`') --> 'abc'
str {string}
quoteChars {string}
string}
.subs(str, var_args)Does simple python-style string substitution. subs("foo%s hot%s", "bar", "dog") becomes "foobar hotdog".
str {string}
var_args {...*}
string}
.toCamelCase(str)Converts a string from selector-case to camelCase (e.g. from "multi-part-string" to "multiPartString"), useful for converting CSS selectors and HTML dataset keys to their equivalent JS properties.
str {string}
string}
.toMap(s)Takes a string and creates a map (Object) in which the keys are the characters in the string. The value for the key is set to true. You can then use goog.object.map or goog.array.map to change the values.
s {string}
Object}
.toNumber(str)Converts the supplied string to a number, which may be Ininity or NaN. This function strips whitespace: (toNumber(' 123') === 123) This function accepts scientific notation: (toNumber('1e1') === 10) This is better than Javascript's built-in conversions because, sadly: (Number(' ') === 0) and (parseFloat('123a') === 123)
str {string}
number}
.toSelectorCase(str)Converts a string from camelCase to selector-case (e.g. from "multiPartString" to "multi-part-string"), useful for converting JS style and dataset properties to equivalent CSS selectors and HTML keys.
str {string}
string}
.toTitleCase(str, opt_delimiters)Converts a string into TitleCase. First character of the string is always capitalized in addition to the first letter of every subsequent word. Words are delimited by one or more whitespaces by default. Custom delimiters can optionally be specified to replace the default, which doesn't preserve whitespace delimiters and instead must be explicitly included if needed. Default delimiter => " ": goog.string.toTitleCase('oneTwoThree') => 'OneTwoThree' goog.string.toTitleCase('one two three') => 'One Two Three' goog.string.toTitleCase(' one two ') => ' One Two ' goog.string.toTitleCase('one_two_three') => 'One_two_three' goog.string.toTitleCase('one-two-three') => 'One-two-three' Custom delimiter => "_-.": goog.string.toTitleCase('oneTwoThree', '_-.') => 'OneTwoThree' goog.string.toTitleCase('one two three', '_-.') => 'One two three' goog.string.toTitleCase(' one two ', '_-.') => ' one two ' goog.string.toTitleCase('one_two_three', '_-.') => 'One_Two_Three' goog.string.toTitleCase('one-two-three', '_-.') => 'One-Two-Three' goog.string.toTitleCase('one...two...three', '_-.') => 'One...Two...Three' goog.string.toTitleCase('one. two. three', '_-.') => 'One. two. three' goog.string.toTitleCase('one-two.three', '_-.') => 'One-Two.Three'
str {string}
opt_delimiters {string=}
string}
.trim(str)Trims white spaces to the left and right of a string.
str {string}
string}
.trimLeft(str)Trims whitespaces at the left end of a string.
str {string}
string}
.trimRight(str)Trims whitespaces at the right end of a string.
str {string}
string}
.truncate(str, chars, opt_protectEscapedCharacters)Truncates a string to a certain length and adds '...' if necessary. The length also accounts for the ellipsis, so a maximum length of 10 and a string 'Hello World!' produces 'Hello W...'.
str {string}
chars {number}
opt_protectEscapedCharacters {boolean=}
string}
.truncateMiddle(str, chars, opt_protectEscapedCharacters, opt_trailingChars)Truncate a string in the middle, adding "..." if necessary, and favoring the beginning of the string.
str {string}
chars {number}
opt_protectEscapedCharacters {boolean=}
opt_trailingChars {number=}
string}
.unescapeEntities(str)Unescapes an HTML string.
str {string}
string}
.urlDecode(str)URL-decodes the string. We need to specially handle '+'s because the javascript library doesn't convert them to spaces.
str {string}
string}
.urlEncode(str)URL-encodes a string
str {*}
string}
.whitespaceEscape(str, opt_xml)Do escaping of whitespace to preserve spatial formatting. We use character entity #160 to make it safer for xml.
str {string}
opt_xml {boolean=}
string}