@metreeca/qest - v0.12.0
    Preparing search index...

    Type Alias Dictionary

    Dictionary:
        | { readonly [tag: string]: string }
        | { readonly [tag: string]: readonly string[] }

    Localised text map.

    Holds the localised forms of a property value under the language tags they are written in. The umbrella union admits two forms with disjoint value shapes:

    • a single string value per tag, or
    • an array of string values per tag

    Which of the two a dictionary takes is fixed by the property it belongs to: a resource state carrying the other form under any tag is malformed and rejected. Localised options are exempt, being matched against stored values rather than stored, and accept either form.

    Note

    • A dictionary is conceptually equivalent to an array of language-tagged strings, which idiomatic JSON doesn't directly support
    • The @none key for non-localised values is not supported; use the und tag for language-neutral values
    Note

    A vacuous dictionary, such as {} or { "en": [] }, carries no localised values and MUST be ignored by processors as if the owning field were omitted from the enclosing resource. An empty array standing as a tag's value carries no values either and is ignored in the same way, admissible only where the property takes the array form.