Interface ServerClientOptions

interface ServerClientOptions {
    authorization: string;
    compress?: boolean;
    handshake?: boolean;
    host?: string;
    maxRetryTime?: number;
    messagepack?: boolean;
    options?: ConnectOpts | ConnectionOptions;
    path?: string;
    port?: number;
    reconnect?: boolean;
    retries?: number;
    tls?: boolean;
    type?: string;
}

Hierarchy

  • ClientOptions
    • ServerClientOptions

Properties

authorization compress? handshake? host? maxRetryTime? messagepack? options? path? port? reconnect? retries? tls? type?

Properties

authorization

authorization: string

Client authorization token.

Optional compress

compress?: boolean

Optional handshake

handshake?: boolean

Optional host

host?: string

Optional maxRetryTime

maxRetryTime?: number

Optional messagepack

messagepack?: boolean

Optional options

options?: ConnectOpts | ConnectionOptions

Optional path

path?: string

Optional port

port?: number

Optional reconnect

reconnect?: boolean

Optional retries

retries?: number

Optional tls

tls?: boolean

Optional type

type?: string

Client type.

Settings

Member Visibility

Theme

On This Page

authorizationcompresshandshakehostmaxRetryTimemessagepackoptionspathportreconnectretriestlstype

Generated using TypeDoc