Socket | ⚡️Boltwall⚡️

Hierarchy

Duplex
- Socket

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Socket(options?: SocketConstructorOpts): Socket

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

Properties

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connecting

connecting: boolean

destroyed

destroyed: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Optional remoteAddress

remoteAddress: undefined | string

Optional remoteFamily

remoteFamily: undefined | string

Optional remotePort

remotePort: undefined | number

writable

writable: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

__@asyncIterator(): AsyncIterableIterator<any>

Implementation of ReadableStream.__@asyncIterator

Inherited from Readable.__@asyncIterator
- Defined in node_modules/@types/node/stream.d.ts:101
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:224
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:225
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:30
Parameters
- size: number
Returns void

_write

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

Inherited from Duplex._write
- Defined in node_modules/@types/node/stream.d.ts:222
Parameters
- chunk: any
- encoding: string
- 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:223
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:86
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:87
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:88
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:89
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:90
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:91
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/net.d.ts:92
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:93
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:94
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this

address

address(): AddressInfo | string

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

connect

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

- Defined in node_modules/@types/node/net.d.ts:44
Parameters
- options: SocketConnectOpts
- Optional connectionListener: undefined | function
Returns this
- Defined in node_modules/@types/node/net.d.ts:45
Parameters
- port: number
- host: string
- Optional connectionListener: undefined | function
Returns this
- Defined in node_modules/@types/node/net.d.ts:46
Parameters
- port: number
- Optional connectionListener: undefined | function
Returns this
- Defined in node_modules/@types/node/net.d.ts:47
Parameters
- path: string
- Optional connectionListener: undefined | function
Returns this

cork

cork(): void

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

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:41
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:96
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:97
Parameters
- event: "close"
- had_error: boolean
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:98
Parameters
- event: "connect"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:99
Parameters
- event: "data"
- data: Buffer
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:100
Parameters
- event: "drain"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:101
Parameters
- event: "end"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:102
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/net.d.ts:103
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:104
Parameters
- event: "timeout"
Returns boolean

end

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

Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:71
Parameters
- Optional cb: undefined | function
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:72
Parameters
- buffer: Uint8Array | string
- Optional cb: undefined | function
Returns void
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:73
Parameters
- str: Uint8Array | string
- Optional encoding: undefined | string
- Optional cb: undefined | function
Returns void

eventNames

eventNames(): Array<string | symbol>

Implementation of ReadableStream.eventNames

Inherited from EventEmitter.eventNames

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

getMaxListeners

getMaxListeners(): number

Implementation of ReadableStream.getMaxListeners

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

isPaused

isPaused(): boolean

Implementation of ReadableStream.isPaused

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

listenerCount

listenerCount(type: string | symbol): number

Implementation of ReadableStream.listenerCount

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Implementation of ReadableStream.listeners

Inherited from EventEmitter.listeners

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

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:17
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:106
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:107
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:108
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/net.d.ts:109
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:110
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/net.d.ts:111
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/net.d.ts:112
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:113
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:114
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:116
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:117
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:118
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/net.d.ts:119
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:120
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/net.d.ts:121
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/net.d.ts:122
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:123
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:124
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:50
Returns this

pipe

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

Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | object
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:126
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:127
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:128
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/net.d.ts:129
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:130
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/net.d.ts:131
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/net.d.ts:132
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:133
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:134
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:136
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:137
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:138
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:139
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:140
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:141
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:142
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:143
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:144
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this

push

push(chunk: any, encoding?: undefined | string): boolean

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

rawListeners

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

Implementation of ReadableStream.rawListeners

Inherited from EventEmitter.rawListeners

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

read

read(size?: undefined | number): any

Implementation of ReadableStream.read

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

ref

ref(): void

- Defined in node_modules/@types/node/net.d.ts:57
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of ReadableStream.removeAllListeners

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
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: "readable", listener: function): this
removeListener(event: "error", 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:94
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:95
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:96
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:97
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:98
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:99
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:51
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: string): this

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

setEncoding

setEncoding(encoding?: undefined | string): this

Overrides Readable.setEncoding
- Defined in node_modules/@types/node/net.d.ts:49
Parameters
- Optional encoding: undefined | string
Returns this

setKeepAlive

setKeepAlive(enable?: undefined | false | true, initialDelay?: undefined | number): this

- Defined in node_modules/@types/node/net.d.ts:54
Parameters
- Optional enable: undefined | false | true
- Optional initialDelay: undefined | number
Returns this

setMaxListeners

setMaxListeners(n: number): this

Implementation of ReadableStream.setMaxListeners

Inherited from EventEmitter.setMaxListeners

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

setNoDelay

setNoDelay(noDelay?: undefined | false | true): this

- Defined in node_modules/@types/node/net.d.ts:53
Parameters
- Optional noDelay: undefined | false | true
Returns this

setTimeout

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

- Defined in node_modules/@types/node/net.d.ts:52
Parameters
- timeout: number
- Optional callback: undefined | function
Returns this

uncork

uncork(): void

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

unpipe

unpipe(destination?: WritableStream): this

Implementation of ReadableStream.unpipe

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

unref

unref(): void

- Defined in node_modules/@types/node/net.d.ts:56
Returns void

unshift

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

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:37
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:38
Parameters
- oldStream: ReadableStream
Returns this

write

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

Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:41
Parameters
- buffer: Uint8Array | string
- Optional cb: undefined | function
Returns boolean
Overrides Duplex.write
- Defined in node_modules/@types/node/net.d.ts:42
Parameters
- str: Uint8Array | string
- Optional encoding: undefined | string
- Optional cb: undefined | function
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:24
A utility method for creating Readable Streams out of iterators.

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

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: SocketConstructorOpts

Returns Socket

Properties

bufferSize

bytesRead

bytesWritten

connecting

destroyed

localAddress

localPort

readable

readableHighWaterMark

readableLength

Optional remoteAddress

Optional remoteFamily

Optional remotePort

writable

writableFinished

writableHighWaterMark

writableLength

Static defaultMaxListeners

Methods

__@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: string

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

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function