Class Socket

Hierarchy

Duplex
- Socket

Index

Constructors

constructor

Constructors

constructor

new Socket(options?): Socket
Parameters
- Optional options: SocketConstructorOpts
Returns Socket
Overrides Duplex.constructor
- Defined in node_modules/@types/node/net.d.ts:57

Properties

`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

readable

readable: boolean

`Readonly` readableEncoding

readableEncoding: null | BufferEncoding

`Readonly` readableEnded

readableEnded: boolean

`Readonly` readableFlowing

readableFlowing: null | boolean

`Readonly` readableHighWaterMark

readableHighWaterMark: number

`Readonly` readableLength

readableLength: number

`Readonly` readableObjectMode

readableObjectMode: boolean

`Optional` `Readonly` remoteAddress

remoteAddress?: string

`Optional` `Readonly` remoteFamily

remoteFamily?: string

`Optional` `Readonly` remotePort

remotePort?: number

`Readonly` writable

writable: boolean

`Readonly` writableCorked

writableCorked: number

`Readonly` writableEnded

writableEnded: boolean

`Readonly` writableFinished

writableFinished: boolean

`Readonly` writableHighWaterMark

writableHighWaterMark: number

`Readonly` writableLength

writableLength: number

`Readonly` writableObjectMode

writableObjectMode: boolean

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`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.

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<any>
Returns AsyncIterableIterator<any>
Inherited from Duplex.[asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:124

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error) => void)
  - - (error): void
    - Parameters
      error: null | Error
      Returns void
Returns void
Inherited from Duplex._destroy
- Defined in node_modules/@types/node/stream.d.ts:257

_final

_final(callback): void
Parameters
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Inherited from Duplex._final
- Defined in node_modules/@types/node/stream.d.ts:258

_read

_read(size): void
Parameters
- size: number
Returns void
Inherited from Duplex._read
- Defined in node_modules/@types/node/stream.d.ts:37

_write

_write(chunk, encoding, callback): void
Parameters
- chunk: any
- encoding: string
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Inherited from Duplex._write
- Defined in node_modules/@types/node/stream.d.ts:255

`Optional` _writev

_writev(chunks, callback): void
Parameters
- chunks: {
  chunk: any;
  encoding: string;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Inherited from Duplex._writev
- Defined in node_modules/@types/node/stream.d.ts:256

addListener

addListener(event, listener): Socket
events.EventEmitter
1. close
2. connect
3. data
4. drain
5. end
6. error
7. lookup
8. timeout
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:105
addListener(event, listener): Socket
Parameters
- event: "close"
- listener: ((had_error) => void)
  - - (had_error): void
    - Parameters
      had_error: boolean
      Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:106
addListener(event, listener): Socket
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:107
addListener(event, listener): Socket
Parameters
- event: "data"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: Buffer
      Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:108
addListener(event, listener): Socket
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:109
addListener(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:110
addListener(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:111
addListener(event, listener): Socket
Parameters
- event: "lookup"
- listener: ((err, address, family, host) => void)
  - - (err, address, family, host): void
    - Parameters
      err: Error
      address: string
      family: string | number
      host: string
      Returns void
Returns Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:112
addListener(event, listener): Socket
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides stream.Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:113

address

address(): string | AddressInfo
Returns string | AddressInfo
- Defined in node_modules/@types/node/net.d.ts:74

connect

connect(options, connectionListener?): Socket
Parameters
- options: SocketConnectOpts
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:63
connect(port, host, connectionListener?): Socket
Parameters
- port: number
- host: string
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:64
connect(port, connectionListener?): Socket
Parameters
- port: number
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:65
connect(path, connectionListener?): Socket
Parameters
- path: string
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:66

cork

cork(): void
Returns void
Inherited from Duplex.cork
- Defined in node_modules/@types/node/stream.d.ts:265

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void
Inherited from Duplex.destroy
- Defined in node_modules/@types/node/stream.d.ts:48

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:115
emit(event, had_error): boolean
Parameters
- event: "close"
- had_error: boolean
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:116
emit(event): boolean
Parameters
- event: "connect"
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:117
emit(event, data): boolean
Parameters
- event: "data"
- data: Buffer
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:118
emit(event): boolean
Parameters
- event: "drain"
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:119
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:120
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:121
emit(event, err, address, family, host): boolean
Parameters
- event: "lookup"
- err: Error
- address: string
- family: string | number
- host: string
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:122
emit(event): boolean
Parameters
- event: "timeout"
Returns boolean
Overrides stream.Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:123

end

end(cb?): void
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:90
end(buffer, cb?): void
Parameters
- buffer: string | Uint8Array
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:91
end(str, encoding?, cb?): void
Parameters
- str: string | Uint8Array
- Optional encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:92

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from Duplex.eventNames
- Defined in node_modules/@types/node/globals.d.ts:584

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Duplex.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:576

isPaused

isPaused(): boolean
Returns boolean
Inherited from Duplex.isPaused
- Defined in node_modules/@types/node/stream.d.ts:42

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Inherited from Duplex.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:580

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Duplex.listeners
- Defined in node_modules/@types/node/globals.d.ts:577

off

off(event, listener): Socket
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Inherited from Duplex.off
- Defined in node_modules/@types/node/globals.d.ts:573

on

on(event, listener): Socket
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:125
on(event, listener): Socket
Parameters
- event: "close"
- listener: ((had_error) => void)
  - - (had_error): void
    - Parameters
      had_error: boolean
      Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:126
on(event, listener): Socket
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:127
on(event, listener): Socket
Parameters
- event: "data"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: Buffer
      Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:128
on(event, listener): Socket
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:129
on(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:130
on(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:131
on(event, listener): Socket
Parameters
- event: "lookup"
- listener: ((err, address, family, host) => void)
  - - (err, address, family, host): void
    - Parameters
      err: Error
      address: string
      family: string | number
      host: string
      Returns void
Returns Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:132
on(event, listener): Socket
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides stream.Duplex.on
- Defined in node_modules/@types/node/net.d.ts:133

once

once(event, listener): Socket
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:135
once(event, listener): Socket
Parameters
- event: "close"
- listener: ((had_error) => void)
  - - (had_error): void
    - Parameters
      had_error: boolean
      Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:136
once(event, listener): Socket
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:137
once(event, listener): Socket
Parameters
- event: "data"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: Buffer
      Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:138
once(event, listener): Socket
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:139
once(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:140
once(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:141
once(event, listener): Socket
Parameters
- event: "lookup"
- listener: ((err, address, family, host) => void)
  - - (err, address, family, host): void
    - Parameters
      err: Error
      address: string
      family: string | number
      host: string
      Returns void
Returns Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:142
once(event, listener): Socket
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides stream.Duplex.once
- Defined in node_modules/@types/node/net.d.ts:143

pause

pause(): Socket
Returns Socket
Overrides Duplex.pause
- Defined in node_modules/@types/node/net.d.ts:69

pipe

pipe<T>(destination, options?): T
Type Parameters
- T extends WritableStream
Parameters
- destination: T
- Optional options: {
  end?: boolean;
  }
  - Optional end?: boolean
Returns T
Inherited from Duplex.pipe
- Defined in node_modules/@types/node/stream.d.ts:5

prependListener

prependListener(event, listener): Socket
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:145
prependListener(event, listener): Socket
Parameters
- event: "close"
- listener: ((had_error) => void)
  - - (had_error): void
    - Parameters
      had_error: boolean
      Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:146
prependListener(event, listener): Socket
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:147
prependListener(event, listener): Socket
Parameters
- event: "data"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: Buffer
      Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:148
prependListener(event, listener): Socket
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:149
prependListener(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:150
prependListener(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:151
prependListener(event, listener): Socket
Parameters
- event: "lookup"
- listener: ((err, address, family, host) => void)
  - - (err, address, family, host): void
    - Parameters
      err: Error
      address: string
      family: string | number
      host: string
      Returns void
Returns Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:152
prependListener(event, listener): Socket
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides stream.Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:153

prependOnceListener

prependOnceListener(event, listener): Socket
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:155
prependOnceListener(event, listener): Socket
Parameters
- event: "close"
- listener: ((had_error) => void)
  - - (had_error): void
    - Parameters
      had_error: boolean
      Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:156
prependOnceListener(event, listener): Socket
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:157
prependOnceListener(event, listener): Socket
Parameters
- event: "data"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: Buffer
      Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:158
prependOnceListener(event, listener): Socket
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:159
prependOnceListener(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:160
prependOnceListener(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:161
prependOnceListener(event, listener): Socket
Parameters
- event: "lookup"
- listener: ((err, address, family, host) => void)
  - - (err, address, family, host): void
    - Parameters
      err: Error
      address: string
      family: string | number
      host: string
      Returns void
Returns Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:162
prependOnceListener(event, listener): Socket
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Overrides stream.Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:163

push

push(chunk, encoding?): boolean
Parameters
- chunk: any
- Optional encoding: string
Returns boolean
Inherited from Duplex.push
- Defined in node_modules/@types/node/stream.d.ts:46

rawListeners

rawListeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Duplex.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:578

read

read(size?): any
Parameters
- Optional size: number
Returns any
Inherited from Duplex.read
- Defined in node_modules/@types/node/stream.d.ts:38

ref

ref(): Socket
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:76

removeAllListeners

removeAllListeners(event?): Socket
Parameters
- Optional event: string | symbol
Returns Socket
Inherited from Duplex.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:574

removeListener

removeListener(event, listener): Socket
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:115
removeListener(event, listener): Socket
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:116
removeListener(event, listener): Socket
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:117
removeListener(event, listener): Socket
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:118
removeListener(event, listener): Socket
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:119
removeListener(event, listener): Socket
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
removeListener(event, listener): Socket
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
removeListener(event, listener): Socket
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122

resume

resume(): Socket
Returns Socket
Overrides Duplex.resume
- Defined in node_modules/@types/node/net.d.ts:70

setDefaultEncoding

setDefaultEncoding(encoding): Socket
Parameters
- encoding: string
Returns Socket
Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:261

setEncoding

setEncoding(encoding?): Socket
Parameters
- Optional encoding: string
Returns Socket
Overrides Duplex.setEncoding
- Defined in node_modules/@types/node/net.d.ts:68

setKeepAlive

setKeepAlive(enable?, initialDelay?): Socket
Parameters
- Optional enable: boolean
- Optional initialDelay: number
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:73

setMaxListeners

setMaxListeners(n): Socket
Parameters
- n: number
Returns Socket
Inherited from Duplex.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:575

setNoDelay

setNoDelay(noDelay?): Socket
Parameters
- Optional noDelay: boolean
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:72

setTimeout

setTimeout(timeout, callback?): Socket
Parameters
- timeout: number
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:71

uncork

uncork(): void
Returns void
Inherited from Duplex.uncork
- Defined in node_modules/@types/node/stream.d.ts:266

unpipe

unpipe(destination?): Socket
Parameters
- Optional destination: WritableStream
Returns Socket
Inherited from Duplex.unpipe
- Defined in node_modules/@types/node/stream.d.ts:43

unref

unref(): Socket
Returns Socket
- Defined in node_modules/@types/node/net.d.ts:75

unshift

unshift(chunk, encoding?): void
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void
Inherited from Duplex.unshift
- Defined in node_modules/@types/node/stream.d.ts:44

wrap

wrap(oldStream): Socket
Parameters
- oldStream: ReadableStream
Returns Socket
Inherited from Duplex.wrap
- Defined in node_modules/@types/node/stream.d.ts:45

write

write(buffer, cb?): boolean
Parameters
- buffer: string | Uint8Array
- Optional cb: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns boolean
Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:60
write(str, encoding?, cb?): boolean
Parameters
- str: string | Uint8Array
- Optional encoding: string
- Optional cb: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns boolean
Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:61

`Static` from

from(iterable, options?): Readable
A utility method for creating Readable Streams out of iterators.
Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable
Inherited from Duplex.from
- Defined in node_modules/@types/node/stream.d.ts:26

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from Duplex.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from Duplex.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Duplex.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from Duplex.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Socket

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: SocketConstructorOpts

Returns Socket

Properties

Readonly bufferSize

Readonly bytesRead

Readonly bytesWritten

Readonly connecting

Readonly destroyed

Readonly localAddress

Readonly localPort

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Optional Readonly remoteAddress

Optional Readonly remoteFamily

Optional Readonly remotePort

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

[asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: null | Error

callback: ((error) => void)

Parameters

error: null | Error

Returns void

Returns void

_final

Parameters

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: string

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional _writev

Parameters

chunks: { chunk: any; encoding: string; }[]

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

addListener

`Optional` options: SocketConstructorOpts

`Readonly` bufferSize

`Readonly` bytesRead

`Readonly` bytesWritten

`Readonly` connecting

`Readonly` destroyed

`Readonly` localAddress

`Readonly` localPort

`Readonly` readableEncoding

`Readonly` readableEnded

`Readonly` readableFlowing

`Readonly` readableHighWaterMark

`Readonly` readableLength

`Readonly` readableObjectMode

`Optional` `Readonly` remoteAddress

`Optional` `Readonly` remoteFamily

`Optional` `Readonly` remotePort

`Readonly` writable

`Readonly` writableCorked

`Readonly` writableEnded

`Readonly` writableFinished

`Readonly` writableHighWaterMark

`Readonly` writableLength

`Readonly` writableObjectMode

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Optional` error: null | Error

`Optional` error: null | Error

`Optional` _writev

chunks: {
chunk: any;
encoding: string;
}[]

`Optional` error: null | Error

`Rest` ...args: any[]

`Optional` connectionListener: (() => void)

`Optional` connectionListener: (() => void)