Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add length operator

...

The capitalize() operator capitalizes the first character in the target string. 

Code Block
languagejavascript
themeConfluencelanguagejavascript
a = "heat";
b = a.capitalize(); // b = "Heat"

...

The decode() operator converts a JSON string into the equivalent KRL data structure. For example:

Code Block
languagejavascript
themeConfluence
languagejavascript
a = "[3, 4, 5]";
c = a.decode(); // c = [3, 4, 5]

...

The extract() operator matches the string using a regular expression given as the sole argument and returns the specified capture groups as an array. For example:

Code Block
languagejavascript
themeConfluencelanguagejavascript
foo = "I like cheese";
my_str = "This is a string";
a = my_str.extract(re/re#(is)/#) // a = ["is"]
b = my_str.extract(re/re#(s.+).*(.ing)/#) // b = ["s is a st","ring"]
c = my_str.extract(re/re#(boot)/#) // c = []
d = foo.extract(re/likere#like (\w+)/#) // d = ["cheese"]
e = foo.extract(re/re#(e)/g#g) // e = ["e","e","e","e"]

...

The lc() operator returns the lowercase version of the original string. For example:

Code Block
language
languagejavascript
themeConfluencejavascript
a = "Hello World";
c = a.lc() // c = "hello world"

length()

The length() operator returns a number that is the number of characters in the string For example:

Code Block
languagejavascript
themeConfluence
a = "ABC"];
c = a.length(); // c = 3

ma

match()

The match() operator takes a regular expression as its argument. The result is true if the regular expression matches the string and false otherwise. For example:

Code Block
languagejavascript
themeConfluence
languagejavascript
my_str = "This is a string";
a = my_str.match(re/is/) // a = true
b = my_str.match(re/mouse/) // b = false

...

The replace() operator takes two arguments: a regular expression and a string. The returned string is the original string with any match of the regular expression replaced by the second argument. You can use any captured values in the second, substitute string by naming them with $1, $2, and so on. The first captured value will be substituted for $1, the second for $2, and so on. For example:

Code Block
languagejavascript
themeConfluencelanguagejavascript
my_str = "This is a string";
my_url = "http://www.amazon.com/gp/products/123456789/";
a = my_str.replace(re/is/,"ese");                            // a = "These is a string"
b = my_str.replace(re/is/g,"ese");                           // b = "These ese a string"
c = my_str.replace(re/this/,"That");                         // c = "This is a string" (no change)
d = my_str.replace(re/this/i,"That");                        // d = "That is a string"
e = my_url.replace(re#^http://(\[A-Za-z0-9.-\]+)/.*#,"$1");  // e = "www.amazon.com"

In the final example, I was careful to ensure that the regular expression matched the entire URL, so that the substitution of $1 resulted in just the domain name. This same result could be more easily achieved using extract()—although the result, e, would be an array:

Code Block
language
languagejavascript
themeConfluencejavascript
e = my_url.extract(re#^http://(\[A-Za-z0-9.-\]+)/#);

...

The split() operator takes a regular expression as its sole argument. The regular expression is used to split the original string into an array. For example:

Code Block
languagejavascript
themeConfluence
languagejavascript
a = "A;B;C"
c = a.split(re/;/) // c = ["A","B","C"]

...

The sprintf() operator can be applied to either a number or a string. The operator takes a formatting string as its sole argument. The formatting string follows the conventions for sprintf() established in other languages. Specifically, the KRL version of sprintf() follows the formatting conventions for Perl. For example:

Code Block
language
languagejavascript
themeConfluencejavascript
a = 10
c = a.sprintf("< %d>") // c = "< 10>"

...

The substr() operator returns a substring of the target string. The operator takes an argument that gives an offset from the start of the string to begin returning the substring and an optional length that gives the desired length of the substring. If the length is omitted, the substring to the end of the original string from the offset will be returned. If the length is negative, the length will be caluclated from the end of the string. For example:

Code Block
languagejavascript
themeConfluencelanguagejavascript
my_str = "This is a string";
my_str.substr(5);     // returns "is a string"
my_str.substr(5, 4);  // returns "is a"
my_str.substr(5, -5); // returns "is a s"
my_str.substr(25);    // returns null

...

The uc() operator returns the uppercase version of the original string. For example:

Code Block
languagejavascript
themeConfluencelanguagejavascript
a = "Hello World";
c = a.uc() // c = "HELLO WORLD"

...