Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayMetadata

Hierarchy

  • GatewayMetadata

Index

Properties

Optional adapter

adapter: any

The adapter to use for handling rooms. NOTE: this should be a class, not an object

default

typeof Adapter

Optional allowUpgrades

allowUpgrades: boolean

Whether to allow transport upgrades (engine.io)

default

true

Optional cookie

cookie: string | boolean

Name of the HTTP cookie that contains the client sid to send as part of handshake response headers. Set to false to not send one (engine.io)

default

"io"

Optional handlePreflightRequest

handlePreflightRequest: ((req: any, res: any) => void) | boolean

Whether to let engine.io handle the OPTIONS requests. You can also pass a custom function to handle the requests

default

true

Optional httpCompression

httpCompression: Record<string, any> | boolean

Parameters of the http compression for the polling transports (see zlib). Set to false to disable, or set an object with parameter "threshold:number" to only compress data if the byte size is above this value (1024) (engine.io)

default

true|1024

Optional maxHttpBufferSize

maxHttpBufferSize: number

How many bytes or characters a message can be when polling, before closing the session (to avoid Dos) (engine.io)

default

10E7

Optional namespace

namespace: string | RegExp

The name of a namespace

Optional origins

origins: string

Accepted origins

default

':'

Optional parser

parser: any

Optional path

path: string

The path to ws

default

'/socket.io'

Optional perMessageDeflate

perMessageDeflate: Record<string, any> | boolean

parameters of the WebSocket permessage-deflate extension (see ws module). Set to false to disable (engine.io)

default

true

Optional pingInterval

pingInterval: number

How many milliseconds before sending a new ping packet (keep-alive) (engine.io)

default

25000

Optional pingTimeout

pingTimeout: number

How many milliseconds without a pong packed to consider the connection closed (engine.io)

default

60000

Optional serveClient

serveClient: boolean

Should we serve the client file?

default

true

Optional transports

transports: string[]

Transports to allow connections to (engine.io)

default

['polling','websocket']

Generated using TypeDoc