Class PromiseSocket<TSocket>

Type Parameters

TSocket extends Socket

Hierarchy

PromiseDuplex<TSocket>
- PromiseSocket

Index

Constructors

Properties

_errored? _isPromiseReadable isPromiseReadable isPromiseWritable readable socket stream timeoutHandler? writable

Methods

[asyncIterator] connect destroy end iterate once read readAll setEncoding setTimeout write writeAll [hasInstance]

Constructors

constructor

new PromiseSocket<TSocket>(socket?: TSocket): PromiseSocket<TSocket>
Type Parameters
- TSocket extends Socket<TSocket>
Parameters
- Optional socket: TSocket
Returns PromiseSocket<TSocket>
Overrides PromiseDuplex.constructor
- Defined in node_modules/promise-socket/lib/promise-socket.d.ts:8

Properties

`Optional` _errored

_errored?: Error

`Readonly` _isPromiseReadable

_isPromiseReadable: boolean

`Readonly` isPromiseReadable

isPromiseReadable: boolean

`Readonly` isPromiseWritable

isPromiseWritable: boolean

`Readonly` readable

readable: PromiseReadable<TSocket>

`Readonly` socket

socket: TSocket

`Readonly` stream

stream: TSocket

`Private` `Optional` timeoutHandler

timeoutHandler?: any

`Readonly` writable

writable: PromiseWritable<TSocket>

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<string | Buffer>
Returns AsyncIterableIterator<string | Buffer>
Inherited from PromiseDuplex.[asyncIterator]
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:20

connect

connect(port: number, host?: string): Promise<void>
Parameters
- port: number
- Optional host: string
Returns Promise<void>
- Defined in node_modules/promise-socket/lib/promise-socket.d.ts:9
connect(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in node_modules/promise-socket/lib/promise-socket.d.ts:10
connect(options: SocketConnectOpts): Promise<void>
Parameters
- options: SocketConnectOpts
Returns Promise<void>
- Defined in node_modules/promise-socket/lib/promise-socket.d.ts:11

destroy

destroy(): void
Returns void
Inherited from PromiseDuplex.destroy
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:27

end

end(): Promise<void>
Returns Promise<void>
Inherited from PromiseDuplex.end
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:23

iterate

iterate(size?: number): AsyncIterableIterator<string | Buffer>
Parameters
- Optional size: number
Returns AsyncIterableIterator<string | Buffer>
Inherited from PromiseDuplex.iterate
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:19

once

once(event: "close" | "error" | "end" | "finish"): Promise<void>
Parameters
- event: "close" | "error" | "end" | "finish"
Returns Promise<void>
Inherited from PromiseDuplex.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:24
once(event: "open"): Promise<number>
Parameters
- event: "open"
Returns Promise<number>
Inherited from PromiseDuplex.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:25
once(event: "pipe" | "unpipe"): Promise<ReadableStream>
Parameters
- event: "pipe" | "unpipe"
Returns Promise<ReadableStream>
Inherited from PromiseDuplex.once
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:26

read

read(size?: number): Promise<undefined | string | Buffer>
Parameters
- Optional size: number
Returns Promise<undefined | string | Buffer>
Inherited from PromiseDuplex.read
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:16

readAll

readAll(): Promise<undefined | string | Buffer>
Returns Promise<undefined | string | Buffer>
Inherited from PromiseDuplex.readAll
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:17

setEncoding

setEncoding(encoding: BufferEncoding): PromiseSocket<TSocket>
Parameters
- encoding: BufferEncoding
Returns PromiseSocket<TSocket>
Inherited from PromiseDuplex.setEncoding
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:18

setTimeout

setTimeout(timeout: number): void
Parameters
- timeout: number
Returns void
- Defined in node_modules/promise-socket/lib/promise-socket.d.ts:12

write

write(chunk: string | Buffer, encoding?: BufferEncoding): Promise<number>
Parameters
- chunk: string | Buffer
- Optional encoding: BufferEncoding
Returns Promise<number>
Inherited from PromiseDuplex.write
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:21

writeAll

writeAll(content: string | Buffer, chunkSize?: number): Promise<number>
Parameters
- content: string | Buffer
- Optional chunkSize: number
Returns Promise<number>
Inherited from PromiseDuplex.writeAll
- Defined in node_modules/promise-duplex/lib/promise-duplex.d.ts:22

`Static` [hasInstance]

[hasInstance](instance: any): boolean
Parameters
- instance: any
Returns boolean
Inherited from PromiseDuplex.[hasInstance]
- Defined in node_modules/promise-readable/lib/promise-readable.d.ts:13

Generated using TypeDoc