Class WebsocketRouteDecoratorConfig

Contains configuration used during the initialization phase to ensure different decorators work together. Used to store configuration for WebSocket route decorators. The configuration is then loaded once the server is started.

Hierarchy

Constructors

Properties

authenticator: WebsocketAuthenticator

Refers to an authenticator used for the decorated method.

modifies: string[] = []

The list of modifies outbounds affected by the method.

modifiesAuthentication: boolean = false

Indicates whether the method modifies authentication.

modifiesFor: {
    filter: MessageFilter;
    outbounds: string[];
}[] = []

The list of modified outbounds affected by the method for filtered subscriptions.

Type declaration

Methods

  • States that data contained within these outbounds might be changed during the execution of this route.

    Parameters

    • filter: MessageFilter

      The message filter used to determine which connection's data needs to be updated.

    • Rest ...items: string[]

      The items to add to the list of modified outbounds.

    Returns void

Generated using TypeDoc