Interface TcpNetConnectOpts

interface TcpNetConnectOpts {
    allowHalfOpen?: boolean;
    autoSelectFamily?: boolean;
    autoSelectFamilyAttemptTimeout?: number;
    family?: number;
    fd?: number;
    hints?: number;
    host?: string;
    keepAlive?: boolean;
    keepAliveInitialDelay?: number;
    localAddress?: string;
    localPort?: number;
    lookup?: LookupFunction;
    noDelay?: boolean;
    onread?: OnReadOpts;
    port: number;
    readable?: boolean;
    signal?: AbortSignal;
    timeout?: number;
    writable?: boolean;
}

Hierarchy (View Summary)

Properties

allowHalfOpen? autoSelectFamily? autoSelectFamilyAttemptTimeout? family? fd? hints? host? keepAlive? keepAliveInitialDelay? localAddress? localPort? lookup? noDelay? onread? port readable? signal? timeout? writable?

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalautoSelectFamily

autoSelectFamily?: boolean

Since

v18.13.0

OptionalautoSelectFamilyAttemptTimeout

autoSelectFamilyAttemptTimeout?: number

Since

v18.13.0

Optionalfamily

family?: number

Optionalfd

fd?: number

Optionalhints

hints?: number

Optionalhost

host?: string

OptionalkeepAlive

keepAlive?: boolean

OptionalkeepAliveInitialDelay

keepAliveInitialDelay?: number

OptionallocalAddress

localAddress?: string

OptionallocalPort

localPort?: number

Optionallookup

lookup?: LookupFunction

OptionalnoDelay

noDelay?: boolean

Optionalonread

onread?: OnReadOpts

If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.

port

port: number

Optionalreadable

readable?: boolean

Optionalsignal

signal?: AbortSignal

Optionaltimeout

timeout?: number

Optionalwritable

writable?: boolean

Settings

Member Visibility

On This Page

Properties