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

    Type Alias Locale

    Locale: { readonly [range: string]: Atomic }

    Localised text map template.

    Requests a localised property as a structured Dictionary, keeping the language tags that coalesced access discards. Each TagRange key is an RFC 4647 basic language range selecting which locales populate the retrieved map by basic filtering: the standalone * matches every tag, and a range such as en matches en along with more specific tags like en-US, so one range may bring back several entries.

    const template: Template = {
    title: { "*": {} }, // every available language
    description: { en: {}, fr: {} } // English and French
    };

    The value slot carries no request of its own: every entry is the Atomic leaf, and per-tag cardinality follows the property rather than the template. Tag ranges select retrieved content only, so a locale map takes no Criteria: matching resources by localised text is stated at the enclosing collection instead, through the ? and ! operators.

    Important

    A locale map MUST include at least one tag range: the empty object {} is an Atomic. The type admits it only because TypeScript cannot express a non-empty index signature; isLocale rejects it at runtime.

    Note

    The @none key for non-localised values is not supported; use the und tag for language-neutral values.

    Type Declaration

    • readonly [range: string]: Atomic