Optional runURLString with words and/or expressions.
Optional options: IApplyToStringOptionsObject containing options for the dictionary, including the language.
const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
const result = dictionary.applyToString("Words are ignored #TEST.DICT_KEY#");
Get all (and only) the expressions in a string and their parameters if applicable, ignoring normal words and phrases.
String with words and/or expressions.
const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
const expressions = dictionary.getExpressionsFromString("Words are ignored #TEST.DICT_KEY#");
Get the language data for a dictionary.
ID or Slug.
Language.
Get value from a key in a specific dictionary for a language.
Name of the language (locale code).
Name of the dictionary.
Name of the key.
const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
const value = dictionary.getValueFromKey("en-US", "TEST", "OK_BUTTON_LABEL");
Parse an expression and extract the names of the dictionary, the key, and any arguments that are passed in the expression.
Returns null if the value passed is not parseable by the RegEx.
String expression.
const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
const value = dictionary.parseExpression("#TAGORUN.WELCOME_TEXT,Hello");
Resolve an expression in a language, replacing the parameters in the dictionary value with the arguments passed in the expression.
Object with the language and the parsed expression (from parseExpression).
const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
const value = dictionary.resolveExpression({
language: "en-US",
expression: {
dictionary: "TEST",
key: "SOME_KEY",
params: [
"first parameter",
],
},
});
Apply the dictionary over a string, parsing the expressions in the string and replacing them with the values found for the respective keys inside the dictionary for a language.
Always returns a string. Return the translated string if there are dictionary expressions, the raw string with no changes if there are no expressions, and an empty string if
rawStringis undefined.