Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

Type aliases

CallOptions

CallOptions: CommonOptions

CloseReason

CloseReason: "transport_error" | "transport_close" | "open_error" | "goodbye" | "close_method"

RegisterOptions

RegisterOptions: CommonOptions

RegistrationHandler

RegistrationHandler<R, A, K>: (args: A, kwargs: K, details: InvocationDetails) => R

Type parameters

  • R = any

  • A: any[] = any

  • K = any

Type declaration

    • (args: A, kwargs: K, details: InvocationDetails): R
    • Parameters

      • args: A
      • kwargs: K
      • details: InvocationDetails

      Returns R

SubscribeOptions

SubscribeOptions: CommonOptions

SubscriptionHandler

SubscriptionHandler<A, K>: (args: A, kwargs: K, details: EventDetails) => void

Type parameters

  • A = any

  • K = any

Type declaration

    • (args: A, kwargs: K, details: EventDetails): void
    • Parameters

      • args: A
      • kwargs: K
      • details: EventDetails

      Returns void

WelcomeDetails

WelcomeDetails: { authid: string; authmethod: string; authprovider?: string; authrole: string; realm?: string; roles: Record<string, unknown> }

Type declaration

  • authid: string
  • authmethod: string
  • Optional authprovider?: string
  • authrole: string
  • Optional realm?: string
  • roles: Record<string, unknown>

Generated using TypeDoc