Magek Framework
    Preparing search index...

    Interface SubscriptionEnvelope

    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 SubscriptionEnvelope {
        currentUser?: UserEnvelope;
        requestID: UUID;
        context?: ContextEnvelope;
        key?: { id: UUID; sequenceKey?: SequenceKey };
        class: Class<ReadModelInterface>;
        className: string;
        version: number;
        filters: ReadModelRequestProperties<TReadModel>;
        sortBy?: ReadModelSortProperties<ReadModelInterface>;
        limit?: number;
        afterCursor?: unknown;
        paginatedVersion?: boolean;
        select?: ProjectionFor<ReadModelInterface>;
        expirationTime: number;
        connectionID: string;
        operation: GraphQLOperation;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

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

    Settings

    Member Visibility

    On This Page

    Properties