123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035 |
- /**
- * > Stability: 2 - Stable
- *
- * The `node:net` module provides an asynchronous network API for creating stream-based
- * TCP or `IPC` servers ({@link createServer}) and clients
- * ({@link createConnection}).
- *
- * It can be accessed using:
- *
- * ```js
- * import net from 'node:net';
- * ```
- * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/net.js)
- */
- declare module "net" {
- import * as stream from "node:stream";
- import { Abortable, EventEmitter } from "node:events";
- import * as dns from "node:dns";
- type LookupFunction = (
- hostname: string,
- options: dns.LookupOptions,
- callback: (err: NodeJS.ErrnoException | null, address: string | dns.LookupAddress[], family?: number) => void,
- ) => void;
- interface AddressInfo {
- address: string;
- family: string;
- port: number;
- }
- interface SocketConstructorOpts {
- fd?: number | undefined;
- allowHalfOpen?: boolean | undefined;
- onread?: OnReadOpts | undefined;
- readable?: boolean | undefined;
- writable?: boolean | undefined;
- signal?: AbortSignal;
- }
- interface OnReadOpts {
- buffer: Uint8Array | (() => Uint8Array);
- /**
- * This function is called for every chunk of incoming data.
- * Two arguments are passed to it: the number of bytes written to `buffer` and a reference to `buffer`.
- * Return `false` from this function to implicitly `pause()` the socket.
- */
- callback(bytesWritten: number, buffer: Uint8Array): boolean;
- }
- // TODO: remove empty ConnectOpts placeholder at next major @types/node version.
- /** @deprecated */
- interface ConnectOpts {}
- interface TcpSocketConnectOpts {
- port: number;
- host?: string | undefined;
- localAddress?: string | undefined;
- localPort?: number | undefined;
- hints?: number | undefined;
- family?: number | undefined;
- lookup?: LookupFunction | undefined;
- noDelay?: boolean | undefined;
- keepAlive?: boolean | undefined;
- keepAliveInitialDelay?: number | undefined;
- /**
- * @since v18.13.0
- */
- autoSelectFamily?: boolean | undefined;
- /**
- * @since v18.13.0
- */
- autoSelectFamilyAttemptTimeout?: number | undefined;
- blockList?: BlockList | undefined;
- }
- interface IpcSocketConnectOpts {
- path: string;
- }
- type SocketConnectOpts = TcpSocketConnectOpts | IpcSocketConnectOpts;
- type SocketReadyState = "opening" | "open" | "readOnly" | "writeOnly" | "closed";
- /**
- * This class is an abstraction of a TCP socket or a streaming `IPC` endpoint
- * (uses named pipes on Windows, and Unix domain sockets otherwise). It is also
- * an `EventEmitter`.
- *
- * A `net.Socket` can be created by the user and used directly to interact with
- * a server. For example, it is returned by {@link createConnection},
- * so the user can use it to talk to the server.
- *
- * It can also be created by Node.js and passed to the user when a connection
- * is received. For example, it is passed to the listeners of a `'connection'` event emitted on a {@link Server}, so the user can use
- * it to interact with the client.
- * @since v0.3.4
- */
- class Socket extends stream.Duplex {
- constructor(options?: SocketConstructorOpts);
- /**
- * Destroys the socket after all data is written. If the `finish` event was already emitted the socket is destroyed immediately.
- * If the socket is still writable it implicitly calls `socket.end()`.
- * @since v0.3.4
- */
- destroySoon(): void;
- /**
- * Sends data on the socket. The second parameter specifies the encoding in the
- * case of a string. It defaults to UTF8 encoding.
- *
- * Returns `true` if the entire data was flushed successfully to the kernel
- * buffer. Returns `false` if all or part of the data was queued in user memory.`'drain'` will be emitted when the buffer is again free.
- *
- * The optional `callback` parameter will be executed when the data is finally
- * written out, which may not be immediately.
- *
- * See `Writable` stream `write()` method for more
- * information.
- * @since v0.1.90
- * @param [encoding='utf8'] Only used when data is `string`.
- */
- write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean;
- write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean;
- /**
- * Initiate a connection on a given socket.
- *
- * Possible signatures:
- *
- * * `socket.connect(options[, connectListener])`
- * * `socket.connect(path[, connectListener])` for `IPC` connections.
- * * `socket.connect(port[, host][, connectListener])` for TCP connections.
- * * Returns: `net.Socket` The socket itself.
- *
- * This function is asynchronous. When the connection is established, the `'connect'` event will be emitted. If there is a problem connecting,
- * instead of a `'connect'` event, an `'error'` event will be emitted with
- * the error passed to the `'error'` listener.
- * The last parameter `connectListener`, if supplied, will be added as a listener
- * for the `'connect'` event **once**.
- *
- * This function should only be used for reconnecting a socket after`'close'` has been emitted or otherwise it may lead to undefined
- * behavior.
- */
- connect(options: SocketConnectOpts, connectionListener?: () => void): this;
- connect(port: number, host: string, connectionListener?: () => void): this;
- connect(port: number, connectionListener?: () => void): this;
- connect(path: string, connectionListener?: () => void): this;
- /**
- * Set the encoding for the socket as a `Readable Stream`. See `readable.setEncoding()` for more information.
- * @since v0.1.90
- * @return The socket itself.
- */
- setEncoding(encoding?: BufferEncoding): this;
- /**
- * Pauses the reading of data. That is, `'data'` events will not be emitted.
- * Useful to throttle back an upload.
- * @return The socket itself.
- */
- pause(): this;
- /**
- * Close the TCP connection by sending an RST packet and destroy the stream.
- * If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected.
- * Otherwise, it will call `socket.destroy` with an `ERR_SOCKET_CLOSED` Error.
- * If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an `ERR_INVALID_HANDLE_TYPE` Error.
- * @since v18.3.0, v16.17.0
- */
- resetAndDestroy(): this;
- /**
- * Resumes reading after a call to `socket.pause()`.
- * @return The socket itself.
- */
- resume(): this;
- /**
- * Sets the socket to timeout after `timeout` milliseconds of inactivity on
- * the socket. By default `net.Socket` do not have a timeout.
- *
- * When an idle timeout is triggered the socket will receive a `'timeout'` event but the connection will not be severed. The user must manually call `socket.end()` or `socket.destroy()` to
- * end the connection.
- *
- * ```js
- * socket.setTimeout(3000);
- * socket.on('timeout', () => {
- * console.log('socket timeout');
- * socket.end();
- * });
- * ```
- *
- * If `timeout` is 0, then the existing idle timeout is disabled.
- *
- * The optional `callback` parameter will be added as a one-time listener for the `'timeout'` event.
- * @since v0.1.90
- * @return The socket itself.
- */
- setTimeout(timeout: number, callback?: () => void): this;
- /**
- * Enable/disable the use of Nagle's algorithm.
- *
- * When a TCP connection is created, it will have Nagle's algorithm enabled.
- *
- * Nagle's algorithm delays data before it is sent via the network. It attempts
- * to optimize throughput at the expense of latency.
- *
- * Passing `true` for `noDelay` or not passing an argument will disable Nagle's
- * algorithm for the socket. Passing `false` for `noDelay` will enable Nagle's
- * algorithm.
- * @since v0.1.90
- * @param [noDelay=true]
- * @return The socket itself.
- */
- setNoDelay(noDelay?: boolean): this;
- /**
- * Enable/disable keep-alive functionality, and optionally set the initial
- * delay before the first keepalive probe is sent on an idle socket.
- *
- * Set `initialDelay` (in milliseconds) to set the delay between the last
- * data packet received and the first keepalive probe. Setting `0` for`initialDelay` will leave the value unchanged from the default
- * (or previous) setting.
- *
- * Enabling the keep-alive functionality will set the following socket options:
- *
- * * `SO_KEEPALIVE=1`
- * * `TCP_KEEPIDLE=initialDelay`
- * * `TCP_KEEPCNT=10`
- * * `TCP_KEEPINTVL=1`
- * @since v0.1.92
- * @param [enable=false]
- * @param [initialDelay=0]
- * @return The socket itself.
- */
- setKeepAlive(enable?: boolean, initialDelay?: number): this;
- /**
- * Returns the bound `address`, the address `family` name and `port` of the
- * socket as reported by the operating system:`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`
- * @since v0.1.90
- */
- address(): AddressInfo | {};
- /**
- * Calling `unref()` on a socket will allow the program to exit if this is the only
- * active socket in the event system. If the socket is already `unref`ed calling`unref()` again will have no effect.
- * @since v0.9.1
- * @return The socket itself.
- */
- unref(): this;
- /**
- * Opposite of `unref()`, calling `ref()` on a previously `unref`ed socket will _not_ let the program exit if it's the only socket left (the default behavior).
- * If the socket is `ref`ed calling `ref` again will have no effect.
- * @since v0.9.1
- * @return The socket itself.
- */
- ref(): this;
- /**
- * This property is only present if the family autoselection algorithm is enabled in `socket.connect(options)`
- * and it is an array of the addresses that have been attempted.
- *
- * Each address is a string in the form of `$IP:$PORT`.
- * If the connection was successful, then the last address is the one that the socket is currently connected to.
- * @since v19.4.0
- */
- readonly autoSelectFamilyAttemptedAddresses: string[];
- /**
- * This property shows the number of characters buffered for writing. The buffer
- * may contain strings whose length after encoding is not yet known. So this number
- * is only an approximation of the number of bytes in the buffer.
- *
- * `net.Socket` has the property that `socket.write()` always works. This is to
- * help users get up and running quickly. The computer cannot always keep up
- * with the amount of data that is written to a socket. The network connection
- * simply might be too slow. Node.js will internally queue up the data written to a
- * socket and send it out over the wire when it is possible.
- *
- * The consequence of this internal buffering is that memory may grow.
- * Users who experience large or growing `bufferSize` should attempt to
- * "throttle" the data flows in their program with `socket.pause()` and `socket.resume()`.
- * @since v0.3.8
- * @deprecated Since v14.6.0 - Use `writableLength` instead.
- */
- readonly bufferSize: number;
- /**
- * The amount of received bytes.
- * @since v0.5.3
- */
- readonly bytesRead: number;
- /**
- * The amount of bytes sent.
- * @since v0.5.3
- */
- readonly bytesWritten: number;
- /**
- * If `true`, `socket.connect(options[, connectListener])` was
- * called and has not yet finished. It will stay `true` until the socket becomes
- * connected, then it is set to `false` and the `'connect'` event is emitted. Note
- * that the `socket.connect(options[, connectListener])` callback is a listener for the `'connect'` event.
- * @since v6.1.0
- */
- readonly connecting: boolean;
- /**
- * This is `true` if the socket is not connected yet, either because `.connect()`has not yet been called or because it is still in the process of connecting
- * (see `socket.connecting`).
- * @since v11.2.0, v10.16.0
- */
- readonly pending: boolean;
- /**
- * See `writable.destroyed` for further details.
- */
- readonly destroyed: boolean;
- /**
- * The string representation of the local IP address the remote client is
- * connecting on. For example, in a server listening on `'0.0.0.0'`, if a client
- * connects on `'192.168.1.1'`, the value of `socket.localAddress` would be`'192.168.1.1'`.
- * @since v0.9.6
- */
- readonly localAddress?: string;
- /**
- * The numeric representation of the local port. For example, `80` or `21`.
- * @since v0.9.6
- */
- readonly localPort?: number;
- /**
- * The string representation of the local IP family. `'IPv4'` or `'IPv6'`.
- * @since v18.8.0, v16.18.0
- */
- readonly localFamily?: string;
- /**
- * This property represents the state of the connection as a string.
- *
- * * If the stream is connecting `socket.readyState` is `opening`.
- * * If the stream is readable and writable, it is `open`.
- * * If the stream is readable and not writable, it is `readOnly`.
- * * If the stream is not readable and writable, it is `writeOnly`.
- * @since v0.5.0
- */
- readonly readyState: SocketReadyState;
- /**
- * The string representation of the remote IP address. For example,`'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if
- * the socket is destroyed (for example, if the client disconnected).
- * @since v0.5.10
- */
- readonly remoteAddress?: string | undefined;
- /**
- * The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. Value may be `undefined` if
- * the socket is destroyed (for example, if the client disconnected).
- * @since v0.11.14
- */
- readonly remoteFamily?: string | undefined;
- /**
- * The numeric representation of the remote port. For example, `80` or `21`. Value may be `undefined` if
- * the socket is destroyed (for example, if the client disconnected).
- * @since v0.5.10
- */
- readonly remotePort?: number | undefined;
- /**
- * The socket timeout in milliseconds as set by `socket.setTimeout()`.
- * It is `undefined` if a timeout has not been set.
- * @since v10.7.0
- */
- readonly timeout?: number | undefined;
- /**
- * Half-closes the socket. i.e., it sends a FIN packet. It is possible the
- * server will still send some data.
- *
- * See `writable.end()` for further details.
- * @since v0.1.90
- * @param [encoding='utf8'] Only used when data is `string`.
- * @param callback Optional callback for when the socket is finished.
- * @return The socket itself.
- */
- end(callback?: () => void): this;
- end(buffer: Uint8Array | string, callback?: () => void): this;
- end(str: Uint8Array | string, encoding?: BufferEncoding, callback?: () => void): this;
- /**
- * events.EventEmitter
- * 1. close
- * 2. connect
- * 3. connectionAttempt
- * 4. connectionAttemptFailed
- * 5. connectionAttemptTimeout
- * 6. data
- * 7. drain
- * 8. end
- * 9. error
- * 10. lookup
- * 11. ready
- * 12. timeout
- */
- addListener(event: string, listener: (...args: any[]) => void): this;
- addListener(event: "close", listener: (hadError: boolean) => void): this;
- addListener(event: "connect", listener: () => void): this;
- addListener(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
- addListener(
- event: "connectionAttemptFailed",
- listener: (ip: string, port: number, family: number, error: Error) => void,
- ): this;
- addListener(
- event: "connectionAttemptTimeout",
- listener: (ip: string, port: number, family: number) => void,
- ): this;
- addListener(event: "data", listener: (data: Buffer) => void): this;
- addListener(event: "drain", listener: () => void): this;
- addListener(event: "end", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(
- event: "lookup",
- listener: (err: Error, address: string, family: string | number, host: string) => void,
- ): this;
- addListener(event: "ready", listener: () => void): this;
- addListener(event: "timeout", listener: () => void): this;
- emit(event: string | symbol, ...args: any[]): boolean;
- emit(event: "close", hadError: boolean): boolean;
- emit(event: "connect"): boolean;
- emit(event: "connectionAttempt", ip: string, port: number, family: number): boolean;
- emit(event: "connectionAttemptFailed", ip: string, port: number, family: number, error: Error): boolean;
- emit(event: "connectionAttemptTimeout", ip: string, port: number, family: number): boolean;
- emit(event: "data", data: Buffer): boolean;
- emit(event: "drain"): boolean;
- emit(event: "end"): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean;
- emit(event: "ready"): boolean;
- emit(event: "timeout"): boolean;
- on(event: string, listener: (...args: any[]) => void): this;
- on(event: "close", listener: (hadError: boolean) => void): this;
- on(event: "connect", listener: () => void): this;
- on(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
- on(
- event: "connectionAttemptFailed",
- listener: (ip: string, port: number, family: number, error: Error) => void,
- ): this;
- on(event: "connectionAttemptTimeout", listener: (ip: string, port: number, family: number) => void): this;
- on(event: "data", listener: (data: Buffer) => void): this;
- on(event: "drain", listener: () => void): this;
- on(event: "end", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(
- event: "lookup",
- listener: (err: Error, address: string, family: string | number, host: string) => void,
- ): this;
- on(event: "ready", listener: () => void): this;
- on(event: "timeout", listener: () => void): this;
- once(event: string, listener: (...args: any[]) => void): this;
- once(event: "close", listener: (hadError: boolean) => void): this;
- once(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
- once(
- event: "connectionAttemptFailed",
- listener: (ip: string, port: number, family: number, error: Error) => void,
- ): this;
- once(event: "connectionAttemptTimeout", listener: (ip: string, port: number, family: number) => void): this;
- once(event: "connect", listener: () => void): this;
- once(event: "data", listener: (data: Buffer) => void): this;
- once(event: "drain", listener: () => void): this;
- once(event: "end", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(
- event: "lookup",
- listener: (err: Error, address: string, family: string | number, host: string) => void,
- ): this;
- once(event: "ready", listener: () => void): this;
- once(event: "timeout", listener: () => void): this;
- prependListener(event: string, listener: (...args: any[]) => void): this;
- prependListener(event: "close", listener: (hadError: boolean) => void): this;
- prependListener(event: "connect", listener: () => void): this;
- prependListener(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
- prependListener(
- event: "connectionAttemptFailed",
- listener: (ip: string, port: number, family: number, error: Error) => void,
- ): this;
- prependListener(
- event: "connectionAttemptTimeout",
- listener: (ip: string, port: number, family: number) => void,
- ): this;
- prependListener(event: "data", listener: (data: Buffer) => void): this;
- prependListener(event: "drain", listener: () => void): this;
- prependListener(event: "end", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(
- event: "lookup",
- listener: (err: Error, address: string, family: string | number, host: string) => void,
- ): this;
- prependListener(event: "ready", listener: () => void): this;
- prependListener(event: "timeout", listener: () => void): this;
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
- prependOnceListener(event: "close", listener: (hadError: boolean) => void): this;
- prependOnceListener(event: "connect", listener: () => void): this;
- prependOnceListener(
- event: "connectionAttempt",
- listener: (ip: string, port: number, family: number) => void,
- ): this;
- prependOnceListener(
- event: "connectionAttemptFailed",
- listener: (ip: string, port: number, family: number, error: Error) => void,
- ): this;
- prependOnceListener(
- event: "connectionAttemptTimeout",
- listener: (ip: string, port: number, family: number) => void,
- ): this;
- prependOnceListener(event: "data", listener: (data: Buffer) => void): this;
- prependOnceListener(event: "drain", listener: () => void): this;
- prependOnceListener(event: "end", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(
- event: "lookup",
- listener: (err: Error, address: string, family: string | number, host: string) => void,
- ): this;
- prependOnceListener(event: "ready", listener: () => void): this;
- prependOnceListener(event: "timeout", listener: () => void): this;
- }
- interface ListenOptions extends Abortable {
- backlog?: number | undefined;
- exclusive?: boolean | undefined;
- host?: string | undefined;
- /**
- * @default false
- */
- ipv6Only?: boolean | undefined;
- reusePort?: boolean | undefined;
- path?: string | undefined;
- port?: number | undefined;
- readableAll?: boolean | undefined;
- writableAll?: boolean | undefined;
- }
- interface ServerOpts {
- /**
- * Indicates whether half-opened TCP connections are allowed.
- * @default false
- */
- allowHalfOpen?: boolean | undefined;
- /**
- * Indicates whether the socket should be paused on incoming connections.
- * @default false
- */
- pauseOnConnect?: boolean | undefined;
- /**
- * If set to `true`, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.
- * @default false
- * @since v16.5.0
- */
- noDelay?: boolean | undefined;
- /**
- * If set to `true`, it enables keep-alive functionality on the socket immediately after a new incoming connection is received,
- * similarly on what is done in `socket.setKeepAlive([enable][, initialDelay])`.
- * @default false
- * @since v16.5.0
- */
- keepAlive?: boolean | undefined;
- /**
- * If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.
- * @default 0
- * @since v16.5.0
- */
- keepAliveInitialDelay?: number | undefined;
- /**
- * Optionally overrides all `net.Socket`s' `readableHighWaterMark` and `writableHighWaterMark`.
- * @default See [stream.getDefaultHighWaterMark()](https://nodejs.org/docs/latest-v22.x/api/stream.html#streamgetdefaulthighwatermarkobjectmode).
- * @since v18.17.0, v20.1.0
- */
- highWaterMark?: number | undefined;
- /**
- * `blockList` can be used for disabling inbound
- * access to specific IP addresses, IP ranges, or IP subnets. This does not
- * work if the server is behind a reverse proxy, NAT, etc. because the address
- * checked against the block list is the address of the proxy, or the one
- * specified by the NAT.
- * @since v22.13.0
- */
- blockList?: BlockList | undefined;
- }
- interface DropArgument {
- localAddress?: string;
- localPort?: number;
- localFamily?: string;
- remoteAddress?: string;
- remotePort?: number;
- remoteFamily?: string;
- }
- /**
- * This class is used to create a TCP or `IPC` server.
- * @since v0.1.90
- */
- class Server extends EventEmitter {
- constructor(connectionListener?: (socket: Socket) => void);
- constructor(options?: ServerOpts, connectionListener?: (socket: Socket) => void);
- /**
- * Start a server listening for connections. A `net.Server` can be a TCP or
- * an `IPC` server depending on what it listens to.
- *
- * Possible signatures:
- *
- * * `server.listen(handle[, backlog][, callback])`
- * * `server.listen(options[, callback])`
- * * `server.listen(path[, backlog][, callback])` for `IPC` servers
- * * `server.listen([port[, host[, backlog]]][, callback])` for TCP servers
- *
- * This function is asynchronous. When the server starts listening, the `'listening'` event will be emitted. The last parameter `callback`will be added as a listener for the `'listening'`
- * event.
- *
- * All `listen()` methods can take a `backlog` parameter to specify the maximum
- * length of the queue of pending connections. The actual length will be determined
- * by the OS through sysctl settings such as `tcp_max_syn_backlog` and `somaxconn` on Linux. The default value of this parameter is 511 (not 512).
- *
- * All {@link Socket} are set to `SO_REUSEADDR` (see [`socket(7)`](https://man7.org/linux/man-pages/man7/socket.7.html) for
- * details).
- *
- * The `server.listen()` method can be called again if and only if there was an
- * error during the first `server.listen()` call or `server.close()` has been
- * called. Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
- *
- * One of the most common errors raised when listening is `EADDRINUSE`.
- * This happens when another server is already listening on the requested`port`/`path`/`handle`. One way to handle this would be to retry
- * after a certain amount of time:
- *
- * ```js
- * server.on('error', (e) => {
- * if (e.code === 'EADDRINUSE') {
- * console.error('Address in use, retrying...');
- * setTimeout(() => {
- * server.close();
- * server.listen(PORT, HOST);
- * }, 1000);
- * }
- * });
- * ```
- */
- listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): this;
- listen(port?: number, hostname?: string, listeningListener?: () => void): this;
- listen(port?: number, backlog?: number, listeningListener?: () => void): this;
- listen(port?: number, listeningListener?: () => void): this;
- listen(path: string, backlog?: number, listeningListener?: () => void): this;
- listen(path: string, listeningListener?: () => void): this;
- listen(options: ListenOptions, listeningListener?: () => void): this;
- listen(handle: any, backlog?: number, listeningListener?: () => void): this;
- listen(handle: any, listeningListener?: () => void): this;
- /**
- * Stops the server from accepting new connections and keeps existing
- * connections. This function is asynchronous, the server is finally closed
- * when all connections are ended and the server emits a `'close'` event.
- * The optional `callback` will be called once the `'close'` event occurs. Unlike
- * that event, it will be called with an `Error` as its only argument if the server
- * was not open when it was closed.
- * @since v0.1.90
- * @param callback Called when the server is closed.
- */
- close(callback?: (err?: Error) => void): this;
- /**
- * Returns the bound `address`, the address `family` name, and `port` of the server
- * as reported by the operating system if listening on an IP socket
- * (useful to find which port was assigned when getting an OS-assigned address):`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`.
- *
- * For a server listening on a pipe or Unix domain socket, the name is returned
- * as a string.
- *
- * ```js
- * const server = net.createServer((socket) => {
- * socket.end('goodbye\n');
- * }).on('error', (err) => {
- * // Handle errors here.
- * throw err;
- * });
- *
- * // Grab an arbitrary unused port.
- * server.listen(() => {
- * console.log('opened server on', server.address());
- * });
- * ```
- *
- * `server.address()` returns `null` before the `'listening'` event has been
- * emitted or after calling `server.close()`.
- * @since v0.1.90
- */
- address(): AddressInfo | string | null;
- /**
- * Asynchronously get the number of concurrent connections on the server. Works
- * when sockets were sent to forks.
- *
- * Callback should take two arguments `err` and `count`.
- * @since v0.9.7
- */
- getConnections(cb: (error: Error | null, count: number) => void): void;
- /**
- * Opposite of `unref()`, calling `ref()` on a previously `unref`ed server will _not_ let the program exit if it's the only server left (the default behavior).
- * If the server is `ref`ed calling `ref()` again will have no effect.
- * @since v0.9.1
- */
- ref(): this;
- /**
- * Calling `unref()` on a server will allow the program to exit if this is the only
- * active server in the event system. If the server is already `unref`ed calling`unref()` again will have no effect.
- * @since v0.9.1
- */
- unref(): this;
- /**
- * Set this property to reject connections when the server's connection count gets
- * high.
- *
- * It is not recommended to use this option once a socket has been sent to a child
- * with `child_process.fork()`.
- * @since v0.2.0
- */
- maxConnections: number;
- connections: number;
- /**
- * Indicates whether or not the server is listening for connections.
- * @since v5.7.0
- */
- readonly listening: boolean;
- /**
- * events.EventEmitter
- * 1. close
- * 2. connection
- * 3. error
- * 4. listening
- * 5. drop
- */
- addListener(event: string, listener: (...args: any[]) => void): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "connection", listener: (socket: Socket) => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "listening", listener: () => void): this;
- addListener(event: "drop", listener: (data?: DropArgument) => void): this;
- emit(event: string | symbol, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "connection", socket: Socket): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "listening"): boolean;
- emit(event: "drop", data?: DropArgument): boolean;
- on(event: string, listener: (...args: any[]) => void): this;
- on(event: "close", listener: () => void): this;
- on(event: "connection", listener: (socket: Socket) => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "listening", listener: () => void): this;
- on(event: "drop", listener: (data?: DropArgument) => void): this;
- once(event: string, listener: (...args: any[]) => void): this;
- once(event: "close", listener: () => void): this;
- once(event: "connection", listener: (socket: Socket) => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "listening", listener: () => void): this;
- once(event: "drop", listener: (data?: DropArgument) => void): this;
- prependListener(event: string, listener: (...args: any[]) => void): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "connection", listener: (socket: Socket) => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "listening", listener: () => void): this;
- prependListener(event: "drop", listener: (data?: DropArgument) => void): this;
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "connection", listener: (socket: Socket) => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "listening", listener: () => void): this;
- prependOnceListener(event: "drop", listener: (data?: DropArgument) => void): this;
- /**
- * Calls {@link Server.close()} and returns a promise that fulfills when the server has closed.
- * @since v20.5.0
- */
- [Symbol.asyncDispose](): Promise<void>;
- }
- type IPVersion = "ipv4" | "ipv6";
- /**
- * The `BlockList` object can be used with some network APIs to specify rules for
- * disabling inbound or outbound access to specific IP addresses, IP ranges, or
- * IP subnets.
- * @since v15.0.0, v14.18.0
- */
- class BlockList {
- /**
- * Adds a rule to block the given IP address.
- * @since v15.0.0, v14.18.0
- * @param address An IPv4 or IPv6 address.
- * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
- */
- addAddress(address: string, type?: IPVersion): void;
- addAddress(address: SocketAddress): void;
- /**
- * Adds a rule to block a range of IP addresses from `start` (inclusive) to`end` (inclusive).
- * @since v15.0.0, v14.18.0
- * @param start The starting IPv4 or IPv6 address in the range.
- * @param end The ending IPv4 or IPv6 address in the range.
- * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
- */
- addRange(start: string, end: string, type?: IPVersion): void;
- addRange(start: SocketAddress, end: SocketAddress): void;
- /**
- * Adds a rule to block a range of IP addresses specified as a subnet mask.
- * @since v15.0.0, v14.18.0
- * @param net The network IPv4 or IPv6 address.
- * @param prefix The number of CIDR prefix bits. For IPv4, this must be a value between `0` and `32`. For IPv6, this must be between `0` and `128`.
- * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
- */
- addSubnet(net: SocketAddress, prefix: number): void;
- addSubnet(net: string, prefix: number, type?: IPVersion): void;
- /**
- * Returns `true` if the given IP address matches any of the rules added to the`BlockList`.
- *
- * ```js
- * const blockList = new net.BlockList();
- * blockList.addAddress('123.123.123.123');
- * blockList.addRange('10.0.0.1', '10.0.0.10');
- * blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6');
- *
- * console.log(blockList.check('123.123.123.123')); // Prints: true
- * console.log(blockList.check('10.0.0.3')); // Prints: true
- * console.log(blockList.check('222.111.111.222')); // Prints: false
- *
- * // IPv6 notation for IPv4 addresses works:
- * console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
- * console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true
- * ```
- * @since v15.0.0, v14.18.0
- * @param address The IP address to check
- * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
- */
- check(address: SocketAddress): boolean;
- check(address: string, type?: IPVersion): boolean;
- /**
- * The list of rules added to the blocklist.
- * @since v15.0.0, v14.18.0
- */
- rules: readonly string[];
- /**
- * Returns `true` if the `value` is a `net.BlockList`.
- * @since v22.13.0
- * @param value Any JS value
- */
- static isBlockList(value: unknown): value is BlockList;
- }
- interface TcpNetConnectOpts extends TcpSocketConnectOpts, SocketConstructorOpts {
- timeout?: number | undefined;
- }
- interface IpcNetConnectOpts extends IpcSocketConnectOpts, SocketConstructorOpts {
- timeout?: number | undefined;
- }
- type NetConnectOpts = TcpNetConnectOpts | IpcNetConnectOpts;
- /**
- * Creates a new TCP or `IPC` server.
- *
- * If `allowHalfOpen` is set to `true`, when the other end of the socket
- * signals the end of transmission, the server will only send back the end of
- * transmission when `socket.end()` is explicitly called. For example, in the
- * context of TCP, when a FIN packed is received, a FIN packed is sent
- * back only when `socket.end()` is explicitly called. Until then the
- * connection is half-closed (non-readable but still writable). See `'end'` event and [RFC 1122](https://tools.ietf.org/html/rfc1122) (section 4.2.2.13) for more information.
- *
- * If `pauseOnConnect` is set to `true`, then the socket associated with each
- * incoming connection will be paused, and no data will be read from its handle.
- * This allows connections to be passed between processes without any data being
- * read by the original process. To begin reading data from a paused socket, call `socket.resume()`.
- *
- * The server can be a TCP server or an `IPC` server, depending on what it `listen()` to.
- *
- * Here is an example of a TCP echo server which listens for connections
- * on port 8124:
- *
- * ```js
- * import net from 'node:net';
- * const server = net.createServer((c) => {
- * // 'connection' listener.
- * console.log('client connected');
- * c.on('end', () => {
- * console.log('client disconnected');
- * });
- * c.write('hello\r\n');
- * c.pipe(c);
- * });
- * server.on('error', (err) => {
- * throw err;
- * });
- * server.listen(8124, () => {
- * console.log('server bound');
- * });
- * ```
- *
- * Test this by using `telnet`:
- *
- * ```bash
- * telnet localhost 8124
- * ```
- *
- * To listen on the socket `/tmp/echo.sock`:
- *
- * ```js
- * server.listen('/tmp/echo.sock', () => {
- * console.log('server bound');
- * });
- * ```
- *
- * Use `nc` to connect to a Unix domain socket server:
- *
- * ```bash
- * nc -U /tmp/echo.sock
- * ```
- * @since v0.5.0
- * @param connectionListener Automatically set as a listener for the {@link 'connection'} event.
- */
- function createServer(connectionListener?: (socket: Socket) => void): Server;
- function createServer(options?: ServerOpts, connectionListener?: (socket: Socket) => void): Server;
- /**
- * Aliases to {@link createConnection}.
- *
- * Possible signatures:
- *
- * * {@link connect}
- * * {@link connect} for `IPC` connections.
- * * {@link connect} for TCP connections.
- */
- function connect(options: NetConnectOpts, connectionListener?: () => void): Socket;
- function connect(port: number, host?: string, connectionListener?: () => void): Socket;
- function connect(path: string, connectionListener?: () => void): Socket;
- /**
- * A factory function, which creates a new {@link Socket},
- * immediately initiates connection with `socket.connect()`,
- * then returns the `net.Socket` that starts the connection.
- *
- * When the connection is established, a `'connect'` event will be emitted
- * on the returned socket. The last parameter `connectListener`, if supplied,
- * will be added as a listener for the `'connect'` event **once**.
- *
- * Possible signatures:
- *
- * * {@link createConnection}
- * * {@link createConnection} for `IPC` connections.
- * * {@link createConnection} for TCP connections.
- *
- * The {@link connect} function is an alias to this function.
- */
- function createConnection(options: NetConnectOpts, connectionListener?: () => void): Socket;
- function createConnection(port: number, host?: string, connectionListener?: () => void): Socket;
- function createConnection(path: string, connectionListener?: () => void): Socket;
- /**
- * Gets the current default value of the `autoSelectFamily` option of `socket.connect(options)`.
- * The initial default value is `true`, unless the command line option`--no-network-family-autoselection` is provided.
- * @since v19.4.0
- */
- function getDefaultAutoSelectFamily(): boolean;
- /**
- * Sets the default value of the `autoSelectFamily` option of `socket.connect(options)`.
- * @param value The new default value.
- * The initial default value is `true`, unless the command line option
- * `--no-network-family-autoselection` is provided.
- * @since v19.4.0
- */
- function setDefaultAutoSelectFamily(value: boolean): void;
- /**
- * Gets the current default value of the `autoSelectFamilyAttemptTimeout` option of `socket.connect(options)`.
- * The initial default value is `250` or the value specified via the command line option `--network-family-autoselection-attempt-timeout`.
- * @returns The current default value of the `autoSelectFamilyAttemptTimeout` option.
- * @since v19.8.0, v18.8.0
- */
- function getDefaultAutoSelectFamilyAttemptTimeout(): number;
- /**
- * Sets the default value of the `autoSelectFamilyAttemptTimeout` option of `socket.connect(options)`.
- * @param value The new default value, which must be a positive number. If the number is less than `10`, the value `10` is used instead. The initial default value is `250` or the value specified via the command line
- * option `--network-family-autoselection-attempt-timeout`.
- * @since v19.8.0, v18.8.0
- */
- function setDefaultAutoSelectFamilyAttemptTimeout(value: number): void;
- /**
- * Returns `6` if `input` is an IPv6 address. Returns `4` if `input` is an IPv4
- * address in [dot-decimal notation](https://en.wikipedia.org/wiki/Dot-decimal_notation) with no leading zeroes. Otherwise, returns`0`.
- *
- * ```js
- * net.isIP('::1'); // returns 6
- * net.isIP('127.0.0.1'); // returns 4
- * net.isIP('127.000.000.001'); // returns 0
- * net.isIP('127.0.0.1/24'); // returns 0
- * net.isIP('fhqwhgads'); // returns 0
- * ```
- * @since v0.3.0
- */
- function isIP(input: string): number;
- /**
- * Returns `true` if `input` is an IPv4 address in [dot-decimal notation](https://en.wikipedia.org/wiki/Dot-decimal_notation) with no
- * leading zeroes. Otherwise, returns `false`.
- *
- * ```js
- * net.isIPv4('127.0.0.1'); // returns true
- * net.isIPv4('127.000.000.001'); // returns false
- * net.isIPv4('127.0.0.1/24'); // returns false
- * net.isIPv4('fhqwhgads'); // returns false
- * ```
- * @since v0.3.0
- */
- function isIPv4(input: string): boolean;
- /**
- * Returns `true` if `input` is an IPv6 address. Otherwise, returns `false`.
- *
- * ```js
- * net.isIPv6('::1'); // returns true
- * net.isIPv6('fhqwhgads'); // returns false
- * ```
- * @since v0.3.0
- */
- function isIPv6(input: string): boolean;
- interface SocketAddressInitOptions {
- /**
- * The network address as either an IPv4 or IPv6 string.
- * @default 127.0.0.1
- */
- address?: string | undefined;
- /**
- * @default `'ipv4'`
- */
- family?: IPVersion | undefined;
- /**
- * An IPv6 flow-label used only if `family` is `'ipv6'`.
- * @default 0
- */
- flowlabel?: number | undefined;
- /**
- * An IP port.
- * @default 0
- */
- port?: number | undefined;
- }
- /**
- * @since v15.14.0, v14.18.0
- */
- class SocketAddress {
- constructor(options: SocketAddressInitOptions);
- /**
- * Either \`'ipv4'\` or \`'ipv6'\`.
- * @since v15.14.0, v14.18.0
- */
- readonly address: string;
- /**
- * Either \`'ipv4'\` or \`'ipv6'\`.
- * @since v15.14.0, v14.18.0
- */
- readonly family: IPVersion;
- /**
- * @since v15.14.0, v14.18.0
- */
- readonly port: number;
- /**
- * @since v15.14.0, v14.18.0
- */
- readonly flowlabel: number;
- /**
- * @since v22.13.0
- * @param input An input string containing an IP address and optional port,
- * e.g. `123.1.2.3:1234` or `[1::1]:1234`.
- * @returns Returns a `SocketAddress` if parsing was successful.
- * Otherwise returns `undefined`.
- */
- static parse(input: string): SocketAddress | undefined;
- }
- }
- declare module "node:net" {
- export * from "net";
- }
|