Interface WebSocketBaseEvent<T, D, S>

interface WebSocketBaseEvent<T, D, S extends string = string> {
    type: T;
    data: D;
    source?: WebSocketEventSource | S;
    metadata: {
        source: ModuleIdentity;
        event: { id: string; parentId?: string };
    };
    route?: RouteConfig;
}

Type Parameters

T
D
S extends string = string

Index

Properties

type data source? metadata route?

Properties

type

type: T

data

data: D

`Optional`source

source?: WebSocketEventSource | S

Deprecated

Prefer metadata.source.

metadata

metadata: { source: ModuleIdentity; event: { id: string; parentId?: string } }

`Optional`route

route?: RouteConfig