Skip to main content

Usage in Deno

import * as mod from "node:net";

Stability: 2 - Stable

The node:net module provides an asynchronous network API for creating stream-based TCP or IPC servers (createServer) and clients (createConnection).

It can be accessed using:

import net from 'node:net';

Classes

Functions

f
createConnection

A factory function, which creates a new Socket, immediately initiates connection with socket.connect(), then returns the net.Socket that starts the connection.

    f
    createServer

    Creates a new TCP or IPC server.

      f
      getDefaultAutoSelectFamily

      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.

        f
        getDefaultAutoSelectFamilyAttemptTimeout

        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.

          f
          isIP

          Returns 6 if input is an IPv6 address. Returns 4 if input is an IPv4 address in dot-decimal notation with no leading zeroes. Otherwise, returns0.

            f
            isIPv4

            Returns true if input is an IPv4 address in dot-decimal notation with no leading zeroes. Otherwise, returns false.

              f
              isIPv6

              Returns true if input is an IPv6 address. Otherwise, returns false.

                f
                setDefaultAutoSelectFamily

                Sets the default value of the autoSelectFamily option of socket.connect(options).

                  f
                  setDefaultAutoSelectFamilyAttemptTimeout

                  Sets the default value of the autoSelectFamilyAttemptTimeout option of socket.connect(options).

                    Interfaces

                    Type Aliases

                    T
                    IPVersion
                    No documentation available
                      T
                      LookupFunction
                      No documentation available
                        T
                        NetConnectOpts
                        No documentation available
                          T
                          SocketConnectOpts
                          No documentation available
                            T
                            SocketReadyState
                            No documentation available
                              Back to top