ws-asyncapi API / core / AuthHandler

Type Alias: AuthHandler<WebsocketData, Topics, Credentials, Query, Headers, Params, Data>

AuthHandler<WebsocketData, Topics, Credentials, Query, Headers, Params, Data> = (data) => MaybePromise<Partial<Data> | Record<string, unknown> | void>

Defined in: .api-entries/core/index.d.ts:267

Handler for credential refresh (.onAuth()). Runs when a client sends fresh credentials on a live connection (an import("./wire.ts").Frame.Auth frame). It receives the validated credentials plus the current context and returns the fields to merge into that context (e.g. the re-decoded user), or throws an import("./wire.ts").RpcError to reject the refresh.

Type Parameters

WebsocketData

WebsocketData extends WebsocketDataType

Topics

Topics extends string

Credentials

Credentials

Query

Query extends unknown | undefined

Headers

Headers extends unknown | undefined

Params

Params extends unknown | undefined

Data

Data

Parameters

data

ws

WebSocketImplementation<WebsocketData, Topics>

credentials

Credentials

request

RequestData<Query, Headers, Params>

data

Data

Returns

MaybePromise<Partial<Data> | Record<string, unknown> | void>