@metreeca/keep
    Preparing search index...

    Type Alias StoreScope

    Store retrieval scope.

    Bounds the aggregates, nesting depth and page size a lookup admits in its model, and sets the locale priority for its localised content. Every member is optional. An empty scope admits any model the shape validates, and resolves localised content against the undetermined und tag alone.

    type StoreScope = {
        locale?: readonly Tag[];
        plain?: boolean;
        depth?: number;
        limit?: number;
    }
    Index

    Properties

    locale?: readonly Tag[]

    Tag priority list driving language negotiation for localised content.

    Entries are matched in order of preference against the language tags available for each localised value.

    ["und"]

    plain?: boolean

    Whether to reject model templates carrying aggregate transforms (count, sum, min, max, avg), admitting retrieval but not computation.

    false, admitting the full query language

    depth?: number

    Maximum nesting admitted for model expansion and query probe paths.

    Each nested resource or path segment counts against the budget. 0 rejects any nested template, but still admits IRI references.

    Unbounded
    
    limit?: number

    Maximum page size admitted for the # pagination constraint on model collections.

    A positive value caps the result set. A # exceeding it, or set to 0 (unbounded), is rejected, and a collection with no # is held to it. 0 leaves result sets unbounded.

    0