Socket | typescript

Hierarchy

Duplex
- Socket

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new Socket(options?: SocketConstructorOpts): Socket

Overrides Duplex.constructor
- Defined in node_modules/@types/node/net.d.ts:64
Parameters
- Optional options: SocketConstructorOpts
Returns Socket

Properties

bufferSize

bufferSize: number

deprecated: since v14.6.0 - Use writableLength instead.

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connecting

connecting: boolean

destroyed

destroyed: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

readableEncoding

readableEncoding: BufferEncoding | null

readableEnded

readableEnded: boolean

readableFlowing

readableFlowing: boolean | null

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

readableObjectMode

readableObjectMode: boolean

Optional remoteAddress

remoteAddress: string

Optional remoteFamily

remoteFamily: string

Optional remotePort

remotePort: number

writable

writable: boolean

writableCorked

writableCorked: number

writableEnded

writableEnded: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

writableObjectMode

writableObjectMode: boolean

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<any>

Implementation of ReadableStream.[Symbol.asyncIterator]

Inherited from Readable.[Symbol.asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:129
Returns AsyncIterableIterator<any>

_destroy

_destroy(error: Error | null, callback: function): void

Inherited from Duplex._destroy

Overrides Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:262
Parameters
- error: Error | null
- callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

_final

_final(callback: function): void

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

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- size: number
Returns void

_write

_write(chunk: any, encoding: BufferEncoding, callback: function): void

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

Optional _writev

_writev(chunks: Array<object>, callback: function): void

Inherited from Duplex._writev
- Defined in node_modules/@types/node/stream.d.ts:261
Parameters
- chunks: Array<object>
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: string, listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "connect", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "drain", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "lookup", listener: function): this
addListener(event: "timeout", listener: function): this

Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:114
events.EventEmitter
1. close
2. connect
3. data
4. drain
5. end
6. error
7. lookup
8. timeout
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:115
Parameters
- event: "close"
- listener: function
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:116
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:117
Parameters
- event: "data"
- listener: function
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:118
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:119
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:120
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:121
Parameters
- event: "lookup"
- listener: function
  - - (err: Error, address: string, family: string | number, host: string): void
    - Parameters
      - err: Error
      - address: string
      - family: string | number
      - host: string
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:122
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this

address

address(): AddressInfo | __type

- Defined in node_modules/@types/node/net.d.ts:82
Returns AddressInfo | __type

connect

connect(options: SocketConnectOpts, connectionListener?: function): this
connect(port: number, host: string, connectionListener?: function): this
connect(port: number, connectionListener?: function): this
connect(path: string, connectionListener?: function): this

- Defined in node_modules/@types/node/net.d.ts:71
Parameters
- options: SocketConnectOpts
- Optional connectionListener: function
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/node/net.d.ts:72
Parameters
- port: number
- host: string
- Optional connectionListener: function
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/node/net.d.ts:73
Parameters
- port: number
- Optional connectionListener: function
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/node/net.d.ts:74
Parameters
- path: string
- Optional connectionListener: function
  - - (): void
    - Returns void
Returns this

cork

cork(): void

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

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:53
Parameters
- Optional error: Error
Returns void

emit

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

Implementation of ReadableStream.emit

Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:124
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:125
Parameters
- event: "close"
- had_error: boolean
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:126
Parameters
- event: "connect"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:127
Parameters
- event: "data"
- data: Buffer
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:128
Parameters
- event: "drain"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:129
Parameters
- event: "end"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:130
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:131
Parameters
- event: "lookup"
- err: Error
- address: string
- family: string | number
- host: string
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:132
Parameters
- event: "timeout"
Returns boolean

end

end(cb?: function): void
end(buffer: Uint8Array | string, cb?: function): void
end(str: Uint8Array | string, encoding?: BufferEncoding, cb?: function): void

Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:99
Parameters
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:100
Parameters
- buffer: Uint8Array | string
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:101
Parameters
- str: Uint8Array | string
- Optional encoding: BufferEncoding
- Optional cb: function
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): Array<string | symbol>

Implementation of ReadableStream.eventNames

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Implementation of ReadableStream.getMaxListeners

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

isPaused

isPaused(): boolean

Implementation of ReadableStream.isPaused

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:47
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Implementation of ReadableStream.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Implementation of ReadableStream.listeners

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: function): this
on(event: "close", listener: function): this
on(event: "connect", listener: function): this
on(event: "data", listener: function): this
on(event: "drain", listener: function): this
on(event: "end", listener: function): this
on(event: "error", listener: function): this
on(event: "lookup", listener: function): this
on(event: "timeout", listener: function): this

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

once

once(event: string, listener: function): this
once(event: "close", listener: function): this
once(event: "connect", listener: function): this
once(event: "data", listener: function): this
once(event: "drain", listener: function): this
once(event: "end", listener: function): this
once(event: "error", listener: function): this
once(event: "lookup", listener: function): this
once(event: "timeout", listener: function): this

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

pause

pause(): this

Implementation of ReadableStream.pause

Overrides Readable.pause
- Defined in node_modules/@types/node/net.d.ts:77
Returns this

pipe

pipe<T>(destination: T, options?: object): T

Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:10
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "connect", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "drain", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "lookup", listener: function): this
prependListener(event: "timeout", listener: function): this

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

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "connect", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "drain", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "lookup", listener: function): this
prependOnceListener(event: "timeout", listener: function): this

Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:164
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:165
Parameters
- event: "close"
- listener: function
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:166
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:167
Parameters
- event: "data"
- listener: function
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:168
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:169
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:170
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:171
Parameters
- event: "lookup"
- listener: function
  - - (err: Error, address: string, family: string | number, host: string): void
    - Parameters
      - err: Error
      - address: string
      - family: string | number
      - host: string
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:172
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this

push

push(chunk: any, encoding?: BufferEncoding): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:51
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns boolean

rawListeners

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

Implementation of ReadableStream.rawListeners

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

Implementation of ReadableStream.read

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- Optional size: number
Returns any

ref

ref(): this

- Defined in node_modules/@types/node/net.d.ts:84
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of ReadableStream.removeAllListeners

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: "pause", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "resume", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): this

Implementation of ReadableStream.resume

Overrides Readable.resume
- Defined in node_modules/@types/node/net.d.ts:78
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: BufferEncoding): this

Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:266
Parameters
- encoding: BufferEncoding
Returns this

setEncoding

setEncoding(encoding?: BufferEncoding): this

Implementation of ReadableStream.setEncoding

Overrides Readable.setEncoding
- Defined in node_modules/@types/node/net.d.ts:76
Parameters
- Optional encoding: BufferEncoding
Returns this

setKeepAlive

setKeepAlive(enable?: boolean, initialDelay?: number): this

- Defined in node_modules/@types/node/net.d.ts:81
Parameters
- Optional enable: boolean
- Optional initialDelay: number
Returns this

setMaxListeners

setMaxListeners(n: number): this

Implementation of ReadableStream.setMaxListeners

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setNoDelay

setNoDelay(noDelay?: boolean): this

- Defined in node_modules/@types/node/net.d.ts:80
Parameters
- Optional noDelay: boolean
Returns this

setTimeout

setTimeout(timeout: number, callback?: function): this

- Defined in node_modules/@types/node/net.d.ts:79
Parameters
- timeout: number
- Optional callback: function
  - - (): void
    - Returns void
Returns this

uncork

uncork(): void

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

unpipe

unpipe(destination?: WritableStream): this

Implementation of ReadableStream.unpipe

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:48
Parameters
- Optional destination: WritableStream
Returns this

unref

unref(): this

- Defined in node_modules/@types/node/net.d.ts:83
Returns this

unshift

unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:49
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): this

Implementation of ReadableStream.wrap

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:50
Parameters
- oldStream: ReadableStream
Returns this

write

write(buffer: Uint8Array | string, cb?: function): boolean
write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: function): boolean

Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:68
Parameters
- buffer: Uint8Array | string
- Optional cb: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns boolean
Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:69
Parameters
- str: Uint8Array | string
- Optional encoding: BufferEncoding
- Optional cb: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns boolean

Static from

from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

Inherited from Readable.from
- Defined in node_modules/@types/node/stream.d.ts:31
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: SocketConstructorOpts

Returns Socket

Properties

bufferSize

bytesRead

bytesWritten

connecting

destroyed

localAddress

localPort

readable

readableEncoding

readableEnded

readableFlowing

readableHighWaterMark

readableLength

readableObjectMode

Optional remoteAddress

Optional remoteFamily

Optional remotePort

writable

writableCorked

writableEnded

writableFinished

writableHighWaterMark

writableLength

writableObjectMode

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

error: Error | null

Returns void

Returns void

_final

Parameters

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: BufferEncoding

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<object>

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: string

listener: function

Parameters