API Reference

Class List

pc.string

Extended String API

Summary

Static Properties

ASCII_LETTERSAll ASCII letters
ASCII_LOWERCASEAll lowercase letters
ASCII_UPPERCASEAll uppercase letters

Static Methods

formatReturn a string with {n} replaced with the n-th argument
fromCodePointGet the string for a given code point or set of code points.
getCodePointGet the code point number for a character in a string.
getCodePointsGets an array of all code points in a string
getSymbolsGets an array of all grapheme clusters (visible symbols) in a string.
toBoolConvert a string value to a boolean.

Details

Static Properties

ASCII_LETTERSAll ASCII letters
ASCII_LOWERCASEAll lowercase letters
ASCII_UPPERCASEAll uppercase letters

Static Methods

format(s, [arguments])

Return a string with {n} replaced with the n-th argument

var s = pc.string.format("Hello {0}", "world");
console.log(s); // Prints "Hello world"

Parameters

sStringThe string to format
argumentsObjectAll other arguments are substituted into the string

Returns

String The formatted string

fromCodePoint(args)

Get the string for a given code point or set of code points. Polyfill for fromCodePoint.

Parameters

argsNumberThe code points to convert to a string

Returns

String The converted string

getCodePoint(string, [i])

Get the code point number for a character in a string. Polyfill for codePointAt.

Parameters

stringStringThe string to get the code point from
iNumberThe index in the string

Returns

Number The code point value for the character in the string

getCodePoints(string)

Gets an array of all code points in a string

Parameters

stringStringThe string to get code points from

Returns

Number[] The code points in the string

getSymbols(string)

Gets an array of all grapheme clusters (visible symbols) in a string. This is needed because some symbols (such as emoji or accented characters) are actually made up of multiple character codes.

Parameters

stringStringThe string to break into symbols

Returns

String[] The symbols in the string

toBool(s, [strict])

Convert a string value to a boolean. In non-strict mode (the default), 'true' is converted to true, all other values are converted to false. In strict mode, 'true' is converted to true, 'false' is converted to false, all other values will throw an Exception.

Parameters

sStringThe string to convert
strictBooleanIn strict mode an Exception is thrown if s is not an accepted string value. Defaults to false

Returns

Boolean The converted value