Interface AGServerOptions
Indexable
[additionalOptions: string]: any
Properties
Optional ackTimeout
ackTimeout?: number
Optional allowClientPublish
allowClientPublish?: boolean
Optional authAlgorithm
authAlgorithm?: string
Optional authDefaultExpiry
authDefaultExpiry?: number
Optional authEngine
Optional authKey
authKey?: Secret
Optional authPrivateKey
authPrivateKey?: Secret
Optional authPublicKey
authPublicKey?: Secret
Optional authVerifyAlgorithms
authVerifyAlgorithms?: string[]
Optional batchInterval
batchInterval?: number
Optional batchOnHandshake
batchOnHandshake?: boolean
Optional batchOnHandshakeDuration
batchOnHandshakeDuration?: number
Optional cloneData
cloneData?: boolean
Optional codecEngine
Optional handshakeTimeout
handshakeTimeout?: number
Optional httpServer
httpServer?: Server<typeof IncomingMessage, typeof ServerResponse>
Optional middlewareEmitFailures
middlewareEmitFailures?: boolean
Optional origins
origins?: string
Optional path
path?: string
Optional perMessageDeflate
perMessageDeflate?: boolean | {}
Optional pingInterval
pingInterval?: number
Optional pingTimeout
pingTimeout?: number
Optional protocolVersion
protocolVersion?: 2 | 1
Optional socketChannelLimit
socketChannelLimit?: number
Optional socketStreamCleanupMode
socketStreamCleanupMode?: "close" | "kill"
Optional wsEngine
wsEngine?: string | {
Server: Server<WebSocket>;
}
Optional wsEngineServerOptions
wsEngineServerOptions?: ClientOptions