Abstract Can contain a reference to another authenticator. When this authenticator instance is used for authentication, this authenticator and the referred authenticator need to grant permission.
Readonly Abstract labelA label that represents the authenticator.
Can contain a reference to another authenticator. When this authenticator instance is used for authentication, either this authenticator or the referred authenticator need to grant permission.
Readonly Abstract unauthenticatedThe message to send when the client is not authenticated.
Add another authenticator. When this authenticator instance is used for authentication, this authenticator and the referred authenticator need to grant permission.
Abstract authenticateAuthenticates the WebSocket connection.
The WebSocket connection or its identifier.
Additional data associated with the request.
A Promise that resolves to a boolean indicating if the authentication is successful.
Checks the authentication for the WebSocket connection.
The WebSocket connection or its identifier.
Additional data associated with the request.
A Promise that resolves to a boolean indicating if the authentication is successful.
Add another authenticator. When this authenticator instance is used for authentication, either this authenticator or the referred authenticator need to grant permission.
Generated using TypeDoc
Authenticators are used to check authentication when a client either sends a request (route) or when data should be sent to the client (outbound). Override the authenticate method to implement authentication functionality.