@metreeca/keep
    Preparing search index...

    Type Alias StoreLookup<S, T>

    Store lookup request.

    Names the resource to retrieve with lookup, the shape describing it and the template narrowing the result.

    type StoreLookup<S extends Lazy<ResourceShape>, T extends Model<S, T>> = {
        entry: Reference;
        shape: S;
        model: T;
    }

    Type Parameters

    • S extends Lazy<ResourceShape>

      The shape driving the retrieval

    • T extends Model<S, T>

      The retrieval template, naming only members the shape carries

    Index

    Properties

    entry shape model

    Properties

    Readonlyentry

    entry: Reference

    Absolute identifier of the resource to be retrieved.

    shape: S

    Resource shape the retrieval is validated against, possibly deferred to break definition cycles.

    model: T

    Retrieval template defining the data envelope of the result.

    The template names only members carried by shape, each in a form its range admits. Multi-valued members may also state filtering, ordering and pagination constraints, or a projection in place of a template.

    Settings

    Member Visibility

    On This Page

    Properties