ConnectRequest interface

Request for the connect event.

Properties

claims

The claims that the client WebSocket connection has when it connects.

clientCertificates

The client certificate info that the client WebSocket connection uses to connect.

context

The context of current CloudEvents request.

headers

The headers that the client WebSocket connection has when it connects.

queries

The queries that the client WebSocket connection has when it connects.

query

The query that the client WebSocket connection has when it connects.

subprotocols

The subprotocols that the client WebSocket connection uses to do handshake.

Property Details

claims

The claims that the client WebSocket connection has when it connects.

claims?: Record<string, string[]>

Property Value

Record<string, string[]>

clientCertificates

The client certificate info that the client WebSocket connection uses to connect.

clientCertificates?: Certificate[]

Property Value

context

The context of current CloudEvents request.

context: ConnectionContext

Property Value

headers

The headers that the client WebSocket connection has when it connects.

headers?: Record<string, string[]>

Property Value

Record<string, string[]>

queries

The queries that the client WebSocket connection has when it connects.

queries?: Record<string, string[]>

Property Value

Record<string, string[]>

query

Warning

This API is now deprecated.

Please use queries instead.

The query that the client WebSocket connection has when it connects.

query?: Record<string, string[]>

Property Value

Record<string, string[]>

subprotocols

The subprotocols that the client WebSocket connection uses to do handshake.

subprotocols?: string[]

Property Value

string[]