Class TcpSocket<TSock, TEvents>

TCP socket for establishing connections to TCP servers.

Example usage:

const tcpSocket = new TcpSocket.from();
await tcpSocket.connect(80, "example.com");
await tcpSocket.write("GET / HTTP/1.1\r\nHost: example.com\r\n\r\n");
await tcpSocket.end({ waitForClose: true });

Type Parameters

TSock extends net.Socket = net.Socket
TEvents extends TcpSocketEvents = TcpSocketEvents

Hierarchy (View Summary)

StreamSocket<TSock, TEvents>
- TcpSocket

Index

Constructors

constructor

new TcpSocket<
    TSock extends Socket = Socket,
    TEvents extends TcpSocketEvents = TcpSocketEvents,
>(
    sock: TSock,
): TcpSocket<TSock, TEvents>
Type Parameters
- TSock extends Socket = Socket
- TEvents extends TcpSocketEvents = TcpSocketEvents
Parameters
- sock: TSock
Returns TcpSocket<TSock, TEvents>
Overrides StreamSocket.constructor
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:66

Properties

`Protected` `Readonly`handledErrorEvents

handledErrorEvents: Set<Error> = ...

`Protected` `Readonly`sock

sock: TSock

The underlying Node.js socket.

Accessors

bytesRead

get bytesRead(): number
Total number of bytes read from the socket so far.

Returns number
Inherited from StreamSocket.bytesRead
- Defined in packages/misc-util/src/node/net/stream-socket.ts:132

bytesWritten

get bytesWritten(): number
Total number of bytes written to the socket so far.

Returns number
Inherited from StreamSocket.bytesWritten
- Defined in packages/misc-util/src/node/net/stream-socket.ts:139

closed

get closed(): boolean
Indicates whether the socket has been fully closed.

Returns boolean
Inherited from StreamSocket.closed
- Defined in packages/misc-util/src/node/net/stream-socket.ts:118

connecting

get connecting(): boolean
Whether the socket is currently in the process of connecting.

Returns boolean
Inherited from StreamSocket.connecting
- Defined in packages/misc-util/src/node/net/stream-socket.ts:146

destroyed

get destroyed(): boolean
Indicates whether the underlying socket has been destroyed.

Returns boolean
Inherited from StreamSocket.destroyed
- Defined in packages/misc-util/src/node/net/stream-socket.ts:125

localEndpoint

get localEndpoint(): InetEndpoint | null
Returns the local endpoint information of the socket.

Returns InetEndpoint | null
Throws
If the socket family is not IPv4 or IPv6.
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:98

remoteEndpoint

get remoteEndpoint(): InetEndpoint | null
Returns the remote endpoint information of the socket.

Returns InetEndpoint | null
Throws
If the socket family is not IPv4 or IPv6.
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:75

stream

get stream(): Duplex
Underlying duplex stream for reading and writing data.

This is the wrapped net.Socket instance and can be passed directly to APIs that expect a Node.js stream.

Returns Duplex
Inherited from StreamSocket.stream
- Defined in packages/misc-util/src/node/net/stream-socket.ts:111

timeout

get timeout(): number | null
Current inactivity timeout in milliseconds, or null if disabled.

Returns number | null
Inherited from StreamSocket.timeout
- Defined in packages/misc-util/src/node/net/stream-socket.ts:153
set timeout(timeout: number | null): void
Updates the inactivity timeout for the socket.

When set to a positive number, the socket emits a "timeout" event if no I/O activity occurs within the given number of milliseconds. A value of 0 or null disables the timeout entirely.
Parameters
- timeout: number | null
Returns void
Inherited from StreamSocket.timeout
- Defined in packages/misc-util/src/node/net/stream-socket.ts:164

Methods

connect

connect(
    port: number,
    host?: string,
    options?: {
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        blockList?: BlockList;
        family?: number;
        hints?: number;
        keepAlive?: boolean;
        keepAliveInitialDelay?: number;
        localAddress?: string;
        localPort?: number;
        lookup?: LookupFunction;
        noDelay?: boolean;
    },
): Promise<void>
Establishes a TCP connection to the specified port and host.
Parameters
- port: number
  The port to connect to.
- Optionalhost: string
  The host to connect to (defaults to localhost).
- Optionaloptions: {
      autoSelectFamily?: boolean;
      autoSelectFamilyAttemptTimeout?: number;
      blockList?: BlockList;
      family?: number;
      hints?: number;
      keepAlive?: boolean;
      keepAliveInitialDelay?: number;
      localAddress?: string;
      localPort?: number;
      lookup?: LookupFunction;
      noDelay?: boolean;
  }
  Connection options.
  - OptionalautoSelectFamily?: boolean
    Since
    v18.13.0
  - OptionalautoSelectFamilyAttemptTimeout?: number
    Since
    v18.13.0
  - OptionalblockList?: BlockList
  - Optionalfamily?: number
  - Optionalhints?: number
  - OptionalkeepAlive?: boolean
  - OptionalkeepAliveInitialDelay?: number
  - OptionallocalAddress?: string
  - OptionallocalPort?: number
  - Optionallookup?: LookupFunction
  - OptionalnoDelay?: boolean
Returns Promise<void>
A promise that resolves when the connection is successfully established.
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:144

destroy

destroy(): void
Immediately destroys the underlying socket.

Pending I/O is discarded, the connection is closed and the socket transitions to a terminal state. Any registered "close" listeners will still be invoked.

Returns void
Inherited from StreamSocket.destroy
- Defined in packages/misc-util/src/node/net/stream-socket.ts:250

`Protected`dispatch

dispatch<K extends string | number | symbol>(
event: K,
...args: TEvents[K],
): void
Dispatches an event to all listeners for the given event name.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  The event name.
- ...args: TEvents[K]
  Arguments to pass to listeners.
Returns void
Inherited from StreamSocket.dispatch
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:58

end

end(options?: { waitForClose?: boolean }): Promise<void>
Half-closes the socket, optionally waiting for a full close.

If waitForClose is omitted or false, the promise resolves once the local side has finished sending data and the FIN has been queued. When waitForClose is true, the promise resolves only after the remote side has also closed and the "close" event has fired.
Parameters
- Optionaloptions: { waitForClose?: boolean }
  Optional settings for ending the socket.
Returns Promise<void>
A promise that resolves once the socket has ended.
Inherited from StreamSocket.end
- Defined in packages/misc-util/src/node/net/stream-socket.ts:196

isSubscribed

isSubscribed<K extends string | number | symbol>(
event: K,
listener: Callable<TEvents[K]>,
): boolean
Check if a callback is subscribed to a specific event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  The event name.
- listener: Callable<TEvents[K]>
  The callback to check.
Returns boolean
Inherited from StreamSocket.isSubscribed
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:38

ref

ref(): void
Marks the socket as referenced, preventing the Node.js process from exiting while the socket is active.

Returns void
Inherited from StreamSocket.ref
- Defined in packages/misc-util/src/node/net/stream-socket.ts:172

setKeepAlive

setKeepAlive(enable: boolean, initialDelay?: number): void
Sets the keep-alive option for the socket.
Parameters
- enable: boolean
  Whether to enable keep-alive.
- OptionalinitialDelay: number
  The initial delay in milliseconds before the first keep-alive probe.
Returns void
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:123

setNoDelay

setNoDelay(noDelay: boolean): void
Disables the Nagle algorithm for the socket.
Parameters
- noDelay: boolean
  Whether to disable the Nagle algorithm.
Returns void
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:132

`Protected`setupEventForwarding

setupEventForwarding(): void
Returns void
Overrides StreamSocket.setupEventForwarding
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:170

subscribe<K extends string | number | symbol>(
    event: K,
    listener: Callable<TEvents[K]>,
    options?: EventDispatcherSubscribeOptions,
): Callable | null
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Callable<TEvents[K]>
- Optionaloptions: EventDispatcherSubscribeOptions
Returns Callable | null
Inherited from StreamSocket.subscribe
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:23

unref

unref(): void
Marks the socket as unreferenced, allowing the Node.js process to exit even if the socket is still active.

Returns void
Inherited from StreamSocket.unref
- Defined in packages/misc-util/src/node/net/stream-socket.ts:180

unsubscribe

unsubscribe<K extends string | number | symbol>(
event: K,
listener: Callable<TEvents[K]>,
): void
Unsubscribe a callback from a specific event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  The event name.
- listener: Callable<TEvents[K]>
  The callback to remove.
Returns void
Inherited from StreamSocket.unsubscribe
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:31

wait

wait<K extends string | number | symbol>(
event: K,
options?: EventDispatcherWaitOptions<TEvents[K]>,
): Promise<TEvents[K]>
Wait for the next occurrence of a specific event, optionally matching a predicate.

This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
  The event name to wait for.
- Optionaloptions: EventDispatcherWaitOptions<TEvents[K]>
  Optional settings including predicate and abort signal.
Returns Promise<TEvents[K]>
A promise that resolves with the event arguments as an array.
Inherited from StreamSocket.wait
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:45

write

write(data: Uint8Array): Promise<void>
Writes data to the socket and resolves once the write completes.
Parameters
- data: Uint8Array
  The data to write
Returns Promise<void>
Inherited from StreamSocket.write
- Defined in packages/misc-util/src/node/net/stream-socket.ts:228

`Static`from

from(
    options?: {
        allowHalfOpen?: boolean;
        onread?: OnReadOpts;
        readable?: boolean;
        signal?: AbortSignal;
        writable?: boolean;
    },
): TcpSocket
Creates a new TcpSocket instance.
Parameters
- Optionaloptions: {
      allowHalfOpen?: boolean;
      onread?: OnReadOpts;
      readable?: boolean;
      signal?: AbortSignal;
      writable?: boolean;
  }
  Options for creating the underlying Node.js socket.
Returns TcpSocket
A new TcpSocket instance.
Overrides StreamSocket.from
- Defined in packages/misc-util/src/node/net/tcp-socket.ts:60

Class TcpSocket<TSock, TEvents>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TcpSocket<TSock, TEvents>

Properties

Protected ReadonlyhandledErrorEvents

Protected Readonlysock

Accessors

bytesRead

Returns number

bytesWritten

Returns number

closed

Returns boolean

connecting

Returns boolean

destroyed

Returns boolean

localEndpoint

Returns InetEndpoint | null

Throws

remoteEndpoint

Returns InetEndpoint | null

Throws

stream

Returns Duplex

timeout

Returns number | null

Parameters

Returns void

Methods

connect

Parameters

OptionalautoSelectFamily?: boolean

Since

OptionalautoSelectFamilyAttemptTimeout?: number

Since

OptionalblockList?: BlockList

Optionalfamily?: number

Optionalhints?: number

OptionalkeepAlive?: boolean

OptionalkeepAliveInitialDelay?: number

OptionallocalAddress?: string

OptionallocalPort?: number

Optionallookup?: LookupFunction

OptionalnoDelay?: boolean

Returns Promise<void>

destroy

Returns void

Protecteddispatch

Type Parameters

Parameters

Returns void

end

Parameters

Returns Promise<void>

isSubscribed

Type Parameters

Parameters

Returns boolean

ref

Returns void

setKeepAlive

Parameters

Returns void

setNoDelay

Parameters

Returns void

ProtectedsetupEventForwarding

Returns void

subscribe

`Protected` `Readonly`handledErrorEvents

`Protected` `Readonly`sock

`Optional`autoSelectFamily?: boolean

`Optional`autoSelectFamilyAttemptTimeout?: number

`Optional`blockList?: BlockList

`Optional`family?: number

`Optional`hints?: number

`Optional`keepAlive?: boolean

`Optional`keepAliveInitialDelay?: number

`Optional`localAddress?: string

`Optional`localPort?: number

`Optional`lookup?: LookupFunction

`Optional`noDelay?: boolean

`Protected`dispatch

`Protected`setupEventForwarding

`Static`from