Socket | Documentation

Hierarchy

<internal>.internal.Duplex
- Socket

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

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

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

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

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from Duplex.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

off

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): <internal>.Socket

Inherited from Duplex.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns <internal>.Socket

setMaxListeners

setMaxListeners(n: number): <internal>.Socket

Inherited from Duplex.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns <internal>.Socket

getMaxListeners

getMaxListeners(): number

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

listeners

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

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

rawListeners

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

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

listenerCount

listenerCount(type: string | symbol): number

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

eventNames

eventNames(): (string | symbol)[]

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

write

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

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

connect

connect(options: <internal>.SocketConnectOpts, connectionListener?: (() => void)): <internal>.Socket
connect(port: number, host: string, connectionListener?: (() => void)): <internal>.Socket
connect(port: number, connectionListener?: (() => void)): <internal>.Socket
connect(path: string, connectionListener?: (() => void)): <internal>.Socket

- Defined in node_modules/@types/node/net.d.ts:68
Parameters
- options: <internal>.SocketConnectOpts
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
- Defined in node_modules/@types/node/net.d.ts:69
Parameters
- port: number
- host: string
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
- Defined in node_modules/@types/node/net.d.ts:70
Parameters
- port: number
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
- Defined in node_modules/@types/node/net.d.ts:71
Parameters
- path: string
- Optional connectionListener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

setEncoding

setEncoding(encoding?: string): <internal>.Socket

Overrides Duplex.setEncoding
- Defined in node_modules/@types/node/net.d.ts:73
Parameters
- Optional encoding: string
Returns <internal>.Socket

pause

pause(): <internal>.Socket

Overrides Duplex.pause
- Defined in node_modules/@types/node/net.d.ts:74
Returns <internal>.Socket

resume

resume(): <internal>.Socket

Overrides Duplex.resume
- Defined in node_modules/@types/node/net.d.ts:75
Returns <internal>.Socket

setTimeout

setTimeout(timeout: number, callback?: (() => void)): <internal>.Socket

- Defined in node_modules/@types/node/net.d.ts:76
Parameters
- timeout: number
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

setNoDelay

setNoDelay(noDelay?: boolean): <internal>.Socket

- Defined in node_modules/@types/node/net.d.ts:77
Parameters
- Optional noDelay: boolean
Returns <internal>.Socket

setKeepAlive

setKeepAlive(enable?: boolean, initialDelay?: number): <internal>.Socket

- Defined in node_modules/@types/node/net.d.ts:78
Parameters
- Optional enable: boolean
- Optional initialDelay: number
Returns <internal>.Socket

address

address(): string | <internal>.AddressInfo

- Defined in node_modules/@types/node/net.d.ts:79
Returns string | <internal>.AddressInfo

unref

unref(): void

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

ref

ref(): void

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

end

end(cb?: (() => void)): <internal>.Socket
end(buffer: string | Uint8Array, cb?: (() => void)): <internal>.Socket
end(str: string | Uint8Array, encoding?: string, cb?: (() => void)): <internal>.Socket

Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:106
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:107
Parameters
- buffer: string | Uint8Array
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.end
- Defined in node_modules/@types/node/net.d.ts:108
Parameters
- str: string | Uint8Array
- Optional encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

addListener

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

Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:121
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
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:122
Parameters
- event: "close"
- listener: ((had_error: boolean) => void)
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns <internal>.Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:123
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:124
Parameters
- event: "data"
- listener: ((data: <internal>.Buffer) => void)
  - - (data: <internal>.Buffer): void
    - Parameters
      - data: <internal>.Buffer
      Returns void
Returns <internal>.Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:125
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:126
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:127
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Overrides stream.Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:128
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
Overrides stream.Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:129
Parameters
- event: "ready"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.addListener
- Defined in node_modules/@types/node/net.d.ts:130
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

Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:132
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:133
Parameters
- event: "close"
- had_error: boolean
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:134
Parameters
- event: "connect"
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:135
Parameters
- event: "data"
- data: <internal>.Buffer
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:136
Parameters
- event: "drain"
Returns boolean
Overrides Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:137
Parameters
- event: "end"
Returns boolean
Overrides stream.Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:138
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides stream.Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:139
Parameters
- event: "lookup"
- err: Error
- address: string
- family: string | number
- host: string
Returns boolean
Overrides stream.Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:140
Parameters
- event: "ready"
Returns boolean
Overrides stream.Duplex.emit
- Defined in node_modules/@types/node/net.d.ts:141
Parameters
- event: "timeout"
Returns boolean

on

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

Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:143
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:144
Parameters
- event: "close"
- listener: ((had_error: boolean) => void)
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns <internal>.Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:145
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:146
Parameters
- event: "data"
- listener: ((data: <internal>.Buffer) => void)
  - - (data: <internal>.Buffer): void
    - Parameters
      - data: <internal>.Buffer
      Returns void
Returns <internal>.Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:147
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.on
- Defined in node_modules/@types/node/net.d.ts:148
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.on
- Defined in node_modules/@types/node/net.d.ts:149
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Overrides stream.Duplex.on
- Defined in node_modules/@types/node/net.d.ts:150
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
Overrides stream.Duplex.on
- Defined in node_modules/@types/node/net.d.ts:151
Parameters
- event: "ready"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.on
- Defined in node_modules/@types/node/net.d.ts:152
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

once

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

Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:154
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:155
Parameters
- event: "close"
- listener: ((had_error: boolean) => void)
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns <internal>.Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:156
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:157
Parameters
- event: "data"
- listener: ((data: <internal>.Buffer) => void)
  - - (data: <internal>.Buffer): void
    - Parameters
      - data: <internal>.Buffer
      Returns void
Returns <internal>.Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:158
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.once
- Defined in node_modules/@types/node/net.d.ts:159
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.once
- Defined in node_modules/@types/node/net.d.ts:160
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Overrides stream.Duplex.once
- Defined in node_modules/@types/node/net.d.ts:161
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
Overrides stream.Duplex.once
- Defined in node_modules/@types/node/net.d.ts:162
Parameters
- event: "ready"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.once
- Defined in node_modules/@types/node/net.d.ts:163
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

prependListener

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

Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:165
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:166
Parameters
- event: "close"
- listener: ((had_error: boolean) => void)
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:167
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:168
Parameters
- event: "data"
- listener: ((data: <internal>.Buffer) => void)
  - - (data: <internal>.Buffer): void
    - Parameters
      - data: <internal>.Buffer
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:169
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:170
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:171
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:172
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
Overrides stream.Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:173
Parameters
- event: "ready"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependListener
- Defined in node_modules/@types/node/net.d.ts:174
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

Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:176
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:177
Parameters
- event: "close"
- listener: ((had_error: boolean) => void)
  - - (had_error: boolean): void
    - Parameters
      - had_error: boolean
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:178
Parameters
- event: "connect"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:179
Parameters
- event: "data"
- listener: ((data: <internal>.Buffer) => void)
  - - (data: <internal>.Buffer): void
    - Parameters
      - data: <internal>.Buffer
      Returns void
Returns <internal>.Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:180
Parameters
- event: "drain"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:181
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:182
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:183
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
Overrides stream.Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:184
Parameters
- event: "ready"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Overrides stream.Duplex.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:185
Parameters
- event: "timeout"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket

pipe

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

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

Static from

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

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

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

_read

_read(size: number): void

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

read

read(size?: number): any

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

isPaused

isPaused(): boolean

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

unpipe

unpipe(destination?: <internal>.WritableStream): <internal>.Socket

Inherited from Duplex.unpipe
- Defined in node_modules/@types/node/stream.d.ts:41
Parameters
- Optional destination: <internal>.WritableStream
Returns <internal>.Socket

unshift

unshift(chunk: any, encoding?: <internal>.BufferEncoding): void

Inherited from Duplex.unshift
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- chunk: any
- Optional encoding: <internal>.BufferEncoding
Returns void

wrap

wrap(oldStream: <internal>.ReadableStream): <internal>.Socket

Inherited from Duplex.wrap
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- oldStream: <internal>.ReadableStream
Returns <internal>.Socket

push

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

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

destroy

destroy(error?: Error): <internal>.Socket

Inherited from Duplex.destroy
- Defined in node_modules/@types/node/stream.d.ts:46
Parameters
- Optional error: Error
Returns <internal>.Socket

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

Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:103
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Socket
Inherited from Duplex.removeListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Socket

[asyncIterator]

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

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

_write

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

Inherited from Duplex._write
- Defined in node_modules/@types/node/stream.d.ts:235
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

Inherited from Duplex._writev
- Defined in node_modules/@types/node/stream.d.ts:236
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

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

_final

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

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

setDefaultEncoding

setDefaultEncoding(encoding: string): <internal>.Socket

Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:241
Parameters
- encoding: string
Returns <internal>.Socket

cork

cork(): void

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

uncork

uncork(): void

Inherited from Duplex.uncork
- Defined in node_modules/@types/node/stream.d.ts:246
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

new Socket(options?: <internal>.SocketConstructorOpts): <internal>.Socket

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

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.Socket

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.Socket

setMaxListeners

Parameters

n: number

Returns <internal>.Socket

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

listenerCount

Parameters

type: string | symbol

Returns number

eventNames

Returns (string | symbol)[]

write

Parameters

buffer: string | Uint8Array

Optional cb: ((err?: Error) => void)

Parameters

Optional err: Error

Returns void

Returns boolean

Parameters

str: string | Uint8Array

Optional encoding: string

Optional cb: ((err?: Error) => void)

Parameters

Optional err: Error

Returns void

Returns boolean

connect

Parameters

options: <internal>.SocketConnectOpts

Optional connectionListener: (() => void)

Returns void

Returns <internal>.Socket

Parameters