Interface IEventLaneDefinition

Definition contract for an event lane.

interface IEventLaneDefinition {
    "[symbolFilePath]"?: string;
    applyTo?:
        | readonly (string | IEventDefinition<any>)[]
        | ((event: IEventDefinition<any>) => boolean);
    asyncContexts?: readonly (string | IAsyncContext<unknown>)[];
    id: string;
    meta?: IEventLaneMeta;
}

Hierarchy (View Summary)

IEventLaneDefinition
- IEventLane

Index

Properties

[symbolFilePath]? applyTo? asyncContexts? id meta?

Properties

`Optional`[symbolFilePath]

"[symbolFilePath]"?: string

`Optional`applyTo

applyTo?:
| readonly (string | IEventDefinition<any>)[]
| ((event: IEventDefinition<any>) => boolean)

`Optional`asyncContexts

asyncContexts?: readonly (string | IAsyncContext<unknown>)[]

Async contexts allowed to cross this lane during relay. Defaults to an empty allowlist, meaning no async contexts are forwarded.

id

id: string

`Optional`meta

meta?: IEventLaneMeta