Interface TCPDialOptions

Expose a subset of net.connect options

interface TCPDialOptions {
    allowHalfOpen?: boolean;
    keepAlive?: boolean;
    keepAliveInitialDelay?: number;
    noDelay?: boolean;
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
    upgrader: Upgrader;
}

Hierarchy (view full)

DialTransportOptions<TCPDialEvents>
TCPSocketOptions
- TCPDialOptions

Index

Properties

allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? onProgress? signal? upgrader

Properties

`Optional` allowHalfOpen

allowHalfOpen?: boolean

See

https://nodejs.org/api/net.html#new-netsocketoptions

`Optional` keepAlive

keepAlive?: boolean

See

https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

`Optional` keepAliveInitialDelay

keepAliveInitialDelay?: number

See

https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

`Optional` noDelay

noDelay?: boolean

See

https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

`Optional` onProgress

onProgress?: ((evt) => void)

Type declaration

- (evt): void
- Parameters
  - evt: TCPDialEvents
  Returns void

`Optional` signal

signal?: AbortSignal

upgrader

upgrader: Upgrader

The upgrader turns a MultiaddrConnection into a Connection which should be returned by the transport's dial method