Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Socket

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static once

Static on

Static listenerCount

off

  • off(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Socket

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

removeAllListeners

setMaxListeners

getMaxListeners

  • getMaxListeners(): number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

write

  • write(buffer: string | Uint8Array, cb?: ((err?: Error) => void)): boolean
  • write(str: string | Uint8Array, encoding?: string, cb?: ((err?: Error) => void)): boolean

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: ((err?: Error) => void)
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: string
    • Optional cb: ((err?: Error) => void)
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean

connect

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • port: number
    • host: string
    • Optional connectionListener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • port: number
    • Optional connectionListener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • path: string
    • Optional connectionListener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

setEncoding

pause

resume

setTimeout

  • Parameters

    • timeout: number
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

setNoDelay

  • Parameters

    • Optional noDelay: boolean

    Returns <internal>.Socket

setKeepAlive

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns <internal>.Socket

address

unref

  • unref(): void

  • Returns void

ref

  • ref(): void

  • Returns void

end

  • Parameters

    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: string
    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

addListener

  • events.EventEmitter

    1. close
    2. connect
    3. data
    4. drain
    5. end
    6. error
    7. lookup
    8. timeout

    Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close", had_error: boolean): boolean
  • emit(event: "connect"): boolean
  • emit(event: "data", data: <internal>.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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"
    • had_error: boolean

    Returns boolean

  • Parameters

    • event: "connect"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "lookup"
    • err: Error
    • address: string
    • family: string | number
    • host: string

    Returns boolean

  • Parameters

    • event: "ready"

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

on

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

once

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

prependListener

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

prependOnceListener

  • prependOnceListener(event: string, listener: ((...args: any[]) => void)): <internal>.Socket
  • prependOnceListener(event: "close", listener: ((had_error: boolean) => void)): <internal>.Socket
  • prependOnceListener(event: "connect", listener: (() => void)): <internal>.Socket
  • prependOnceListener(event: "data", listener: ((data: <internal>.Buffer) => void)): <internal>.Socket
  • prependOnceListener(event: "drain", listener: (() => void)): <internal>.Socket
  • prependOnceListener(event: "end", listener: (() => void)): <internal>.Socket
  • prependOnceListener(event: "error", listener: ((err: Error) => void)): <internal>.Socket
  • prependOnceListener(event: "lookup", listener: ((err: Error, address: string, family: string | number, host: string) => void)): <internal>.Socket
  • prependOnceListener(event: "ready", listener: (() => void)): <internal>.Socket
  • prependOnceListener(event: "timeout", listener: (() => void)): <internal>.Socket

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void

        • Parameters

          • had_error: boolean

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    Returns <internal>.Socket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void

        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type Parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

Static from

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

isPaused

  • isPaused(): boolean

  • Returns boolean

unpipe

unshift

wrap

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

destroy

removeListener

  • removeListener(event: "close", listener: (() => void)): <internal>.Socket
  • removeListener(event: "data", listener: ((chunk: any) => void)): <internal>.Socket
  • removeListener(event: "end", listener: (() => void)): <internal>.Socket
  • removeListener(event: "readable", listener: (() => void)): <internal>.Socket
  • removeListener(event: "error", listener: ((err: Error) => void)): <internal>.Socket
  • removeListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Socket

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "data"
    • listener: ((chunk: any) => void)
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns <internal>.Socket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.Socket

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Socket

[asyncIterator]

_write

  • _write(chunk: any, encoding: string, callback: ((error?: Error) => void)): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: ((error?: Error) => void)
        • (error?: Error): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: { chunk: any; encoding: string }[], callback: ((error?: Error) => void)): void

  • Parameters

    • chunks: { chunk: any; encoding: string }[]
    • callback: ((error?: Error) => void)
        • (error?: Error): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

_destroy

  • _destroy(error: Error, callback: ((error: Error) => void)): void

  • Parameters

    • error: Error
    • callback: ((error: Error) => void)
        • (error: Error): void

        • Parameters

          • error: Error

          Returns void

    Returns void

_final

  • _final(callback: ((error?: Error) => void)): void

  • Parameters

    • callback: ((error?: Error) => void)
        • (error?: Error): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

setDefaultEncoding

cork

  • cork(): void

  • Returns void

uncork

  • uncork(): void

  • Returns void

Properties

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly bufferSize

bufferSize: number

Readonly bytesRead

bytesRead: number

Readonly bytesWritten

bytesWritten: number

Readonly connecting

connecting: boolean

Readonly destroyed

destroyed: boolean

Readonly localAddress

localAddress: string

Readonly localPort

localPort: number

Readonly readyState

readyState: <internal>.SocketReadyState

This property represents the state of the connection as a string.

see

{https://nodejs.org/api/net.html#socketreadystate}

since

v0.5.0

Optional Readonly remoteAddress

remoteAddress?: string

Optional Readonly remoteFamily

remoteFamily?: string

Optional Readonly remotePort

remotePort?: number

Optional Readonly timeout

timeout?: number

The socket timeout in milliseconds as set by socket.setTimeout(). It is undefined if a timeout has not been set.

since

v10.7.0

readable

readable: boolean

Readonly readableEncoding

readableEncoding: <internal>.BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Readonly writable

writable: boolean

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

allowHalfOpen

allowHalfOpen: boolean

Constructors

constructor

Generated using TypeDoc