Class DefaultSocketIOAPI<MessageT, RecipientT>`Abstract`

A simple socket interface for sending messages

Type Parameters

MessageT
RecipientT

Hierarchy (view full)

DefaultSocketIOAPI
- DefaultNotificationSocketIOApi
- DefaultChatSocketIOApi

Implements

SocketAPI<MessageT, RecipientT>

Index

Constructors

Methods

close onSubscribe sendMessage startServer

Properties

accessTokenInfo authSecrets io logger opts

Constructors

constructor

new DefaultSocketIOAPI<MessageT, RecipientT>(opts): DefaultSocketIOAPI<MessageT, RecipientT>
Type Parameters
- MessageT
- RecipientT
Parameters
- opts: DefaultSocketIOAPIOptions
Returns DefaultSocketIOAPI<MessageT, RecipientT>
- Defined in src/socket/socket.ts:50

Methods

close

close(): void
Returns void
- Defined in src/socket/socket.ts:148

`Abstract` onSubscribe

onSubscribe(userSocket, payload): Promise<null | NBError>
Parameters
- userSocket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
- payload: unknown
Returns Promise<null | NBError>
- Defined in src/socket/socket.ts:160

`Abstract` sendMessage

sendMessage(options): void
Send a message to a list of recipients Recipients can be arbitrary, but are usually a subscription object on chat service, or a transmission object on notification service
Parameters
- options: {
  message: MessageT;
  recipients: RecipientT[];
  }
  - message: MessageT
  - recipients: RecipientT[]
Returns void
Implementation of SocketAPI.sendMessage
- Defined in src/socket/socket.ts:155

startServer

startServer(opts): Promise<void>
Parameters
- opts: {
  env?: "production" | "development";
  server: Server<typeof IncomingMessage, typeof ServerResponse>;
  }
  - Optional env?: "production" | "development"
  - server: Server<typeof IncomingMessage, typeof ServerResponse>
Returns Promise<void>
- Defined in src/socket/socket.ts:63

Properties

`Protected` accessTokenInfo

accessTokenInfo: Record<string, AccessTokenInfo> = {}

`Protected` authSecrets

authSecrets: AuthSecrets

`Protected` io

io: null | Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> = null

`Protected` logger

logger: null | Logger = null

`Protected` opts

opts: Required<Omit<DefaultSocketIOAPIOptions, "authEncSecret" | "authSignSecret">>

Generated using TypeDoc