Magek Framework
    Preparing search index...

    Interface ReadModelRequestEnvelope<TReadModel>

    An Envelope carries a command/event body together with the name of its class. This is important information for the Distributor to work. Each provider has to implement their own Envelope.

    interface ReadModelRequestEnvelope<TReadModel extends ReadModelInterface> {
        currentUser?: UserEnvelope;
        requestID: UUID;
        context?: ContextEnvelope;
        key?: { id: UUID; sequenceKey?: SequenceKey };
        class: Class<TReadModel>;
        className: string;
        version: number;
        filters: ReadModelRequestProperties<TReadModel>;
        sortBy?: ReadModelSortProperties<TReadModel>;
        limit?: number;
        afterCursor?: unknown;
        paginatedVersion?: boolean;
        select?: ProjectionFor<TReadModel>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    currentUser? requestID context? key? class className version filters sortBy? limit? afterCursor? paginatedVersion? select?

    Properties

    currentUser?: UserEnvelope
    requestID: UUID
    context?: ContextEnvelope
    key?: { id: UUID; sequenceKey?: SequenceKey }
    class: Class<TReadModel>
    className: string
    version: number
    filters: ReadModelRequestProperties<TReadModel>
    sortBy?: ReadModelSortProperties<TReadModel>
    limit?: number
    afterCursor?: unknown
    paginatedVersion?: boolean
    select?: ProjectionFor<TReadModel>

    Settings

    Member Visibility

    On This Page

    Properties