ReadWriteStream | Documentation

Hierarchy

<internal>.ReadableStream
<internal>.WritableStream
- ReadWriteStream

Methods

addListener

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

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

on

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

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

once

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

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

removeListener

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

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

off

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

Inherited from WritableStream.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>.ReadWriteStream

removeAllListeners

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

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

setMaxListeners

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

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

getMaxListeners

getMaxListeners(): number

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

listeners

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

Inherited from WritableStream.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 WritableStream.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:739
Parameters
- event: string | symbol
Returns Function[]

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from WritableStream.emit
- Defined in node_modules/@types/node/globals.d.ts:740
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

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

prependListener

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

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

prependOnceListener

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

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

eventNames

eventNames(): (string | symbol)[]

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

read

read(size?: number): string | <internal>.Buffer

Inherited from ReadableStream.read
- Defined in node_modules/@types/node/globals.d.ts:750
Parameters
- Optional size: number
Returns string | <internal>.Buffer

setEncoding

setEncoding(encoding: string): <internal>.ReadWriteStream

Inherited from ReadableStream.setEncoding
- Defined in node_modules/@types/node/globals.d.ts:751
Parameters
- encoding: string
Returns <internal>.ReadWriteStream

pause

pause(): <internal>.ReadWriteStream

Inherited from ReadableStream.pause
- Defined in node_modules/@types/node/globals.d.ts:752
Returns <internal>.ReadWriteStream

resume

resume(): <internal>.ReadWriteStream

Inherited from ReadableStream.resume
- Defined in node_modules/@types/node/globals.d.ts:753
Returns <internal>.ReadWriteStream

isPaused

isPaused(): boolean

Inherited from ReadableStream.isPaused
- Defined in node_modules/@types/node/globals.d.ts:754
Returns boolean

pipe

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

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

unpipe

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

Inherited from ReadableStream.unpipe
- Defined in node_modules/@types/node/globals.d.ts:756
Parameters
- Optional destination: <internal>.WritableStream
Returns <internal>.ReadWriteStream

unshift

unshift(chunk: string | Uint8Array, encoding?: <internal>.BufferEncoding): void

Inherited from ReadableStream.unshift
- Defined in node_modules/@types/node/globals.d.ts:757
Parameters
- chunk: string | Uint8Array
- Optional encoding: <internal>.BufferEncoding
Returns void

wrap

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

Inherited from ReadableStream.wrap
- Defined in node_modules/@types/node/globals.d.ts:758
Parameters
- oldStream: <internal>.ReadableStream
Returns <internal>.ReadWriteStream

[asyncIterator]

[asyncIterator](): <internal>.AsyncIterableIterator<string | <internal>.Buffer>

Inherited from ReadableStream.[asyncIterator]
- Defined in node_modules/@types/node/globals.d.ts:759
Returns <internal>.AsyncIterableIterator<string | <internal>.Buffer>

write

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

Inherited from WritableStream.write
- Defined in node_modules/@types/node/globals.d.ts:764
Parameters
- buffer: string | Uint8Array
- Optional cb: ((err?: Error) => void)
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns boolean
Inherited from WritableStream.write
- Defined in node_modules/@types/node/globals.d.ts:765
Parameters
- str: string
- Optional encoding: string
- Optional cb: ((err?: Error) => void)
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns boolean

end

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

Inherited from WritableStream.end
- Defined in node_modules/@types/node/globals.d.ts:766
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.ReadWriteStream
Inherited from WritableStream.end
- Defined in node_modules/@types/node/globals.d.ts:767
Parameters
- data: string | Uint8Array
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.ReadWriteStream
Inherited from WritableStream.end
- Defined in node_modules/@types/node/globals.d.ts:768
Parameters
- str: string
- Optional encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.ReadWriteStream

Hierarchy

Index

Methods

Properties

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream

on

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream

once

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream

removeListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.ReadWriteStream

setMaxListeners

Parameters

n: number

Returns <internal>.ReadWriteStream

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

listenerCount

Parameters

type: string | symbol

Returns number

prependListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.ReadWriteStream