TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Class Dictionary

    Hierarchy

    Index

    Constructors

    Properties

    language: string
    runURL?: string

    Methods

    • 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 rawString is undefined.

      Parameters

      Returns Promise<string>

      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.

      Parameters

      • rawString: string

        String with words and/or expressions.

      Returns Promise<IParsedExpression[]>

      const dictionary = new Dictionary({ language: "en-US", token: "my-token" });
      const expressions = dictionary.getExpressionsFromString("Words are ignored #TEST.DICT_KEY#");
    • Get value from a key in a specific dictionary for a language.

      Parameters

      • language: string

        Name of the language (locale code).

      • dictionary: string

        Name of the dictionary.

      • key: string

        Name of the key.

      Returns Promise<string>

      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.

      Parameters

      • expression: string

        String expression.

      Returns IParsedExpression

      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.

      Parameters

      Returns Promise<string>

      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",
      ],
      },
      });