PassThrough | Documentation

Hierarchy

<internal>.internal.Transform
- PassThrough

Methods

Static once

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

Inherited from Transform.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- emitter: <internal>.NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Transform.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 Transform.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 Transform.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>.internal.PassThrough

Inherited from Transform.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>.internal.PassThrough

removeAllListeners

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

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

setMaxListeners

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

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

getMaxListeners

getMaxListeners(): number

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

listeners

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

Inherited from Transform.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 Transform.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 Transform.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:741
Parameters
- type: string | symbol
Returns number

eventNames

eventNames(): (string | symbol)[]

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

pipe

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

Inherited from Transform.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 Transform.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 Transform._read
- Defined in node_modules/@types/node/stream.d.ts:35
Parameters
- size: number
Returns void

read

read(size?: number): any

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

setEncoding

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

Inherited from Transform.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:37
Parameters
- encoding: string
Returns <internal>.internal.PassThrough

pause

pause(): <internal>.internal.PassThrough

Inherited from Transform.pause
- Defined in node_modules/@types/node/stream.d.ts:38
Returns <internal>.internal.PassThrough

resume

resume(): <internal>.internal.PassThrough

Inherited from Transform.resume
- Defined in node_modules/@types/node/stream.d.ts:39
Returns <internal>.internal.PassThrough

isPaused

isPaused(): boolean

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

unpipe

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

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

unshift

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

Inherited from Transform.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>.internal.PassThrough

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

push

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

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

destroy

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

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

addListener

addListener(event: "close", listener: (() => void)): <internal>.internal.PassThrough
addListener(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
addListener(event: "end", listener: (() => void)): <internal>.internal.PassThrough
addListener(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
addListener(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
addListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:57
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:58
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:59
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:60
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.internal.PassThrough

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "readable"): boolean
emit(event: "error", err: Error): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:64
Parameters
- event: "close"
Returns boolean
Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:65
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:66
Parameters
- event: "end"
Returns boolean
Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:67
Parameters
- event: "readable"
Returns boolean
Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:68
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Transform.emit
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

on

on(event: "close", listener: (() => void)): <internal>.internal.PassThrough
on(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
on(event: "end", listener: (() => void)): <internal>.internal.PassThrough
on(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
on(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
on(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.on
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.internal.PassThrough

once

once(event: "close", listener: (() => void)): <internal>.internal.PassThrough
once(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
once(event: "end", listener: (() => void)): <internal>.internal.PassThrough
once(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
once(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
once(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.once
- Defined in node_modules/@types/node/stream.d.ts:83
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.internal.PassThrough

prependListener

prependListener(event: "close", listener: (() => void)): <internal>.internal.PassThrough
prependListener(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
prependListener(event: "end", listener: (() => void)): <internal>.internal.PassThrough
prependListener(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
prependListener(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
prependListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependListener
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.internal.PassThrough

prependOnceListener

prependOnceListener(event: "close", listener: (() => void)): <internal>.internal.PassThrough
prependOnceListener(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
prependOnceListener(event: "end", listener: (() => void)): <internal>.internal.PassThrough
prependOnceListener(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
prependOnceListener(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:94
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.internal.PassThrough

removeListener

removeListener(event: "close", listener: (() => void)): <internal>.internal.PassThrough
removeListener(event: "data", listener: ((chunk: any) => void)): <internal>.internal.PassThrough
removeListener(event: "end", listener: (() => void)): <internal>.internal.PassThrough
removeListener(event: "readable", listener: (() => void)): <internal>.internal.PassThrough
removeListener(event: "error", listener: ((err: Error) => void)): <internal>.internal.PassThrough
removeListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.internal.PassThrough

Inherited from Transform.removeListener
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.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>.internal.PassThrough
Inherited from Transform.removeListener
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.removeListener
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.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>.internal.PassThrough
Inherited from Transform.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>.internal.PassThrough

[asyncIterator]

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

Inherited from Transform.[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 Transform._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 Transform._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 Transform._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 Transform._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

write

write(chunk: any, encoding?: string, cb?: ((error: Error) => void)): boolean
write(chunk: any, cb?: ((error: Error) => void)): boolean

Inherited from Transform.write
- Defined in node_modules/@types/node/stream.d.ts:239
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns boolean
Inherited from Transform.write
- Defined in node_modules/@types/node/stream.d.ts:240
Parameters
- chunk: any
- Optional cb: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns boolean

setDefaultEncoding

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

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

end

end(cb?: (() => void)): <internal>.internal.PassThrough
end(chunk: any, cb?: (() => void)): <internal>.internal.PassThrough
end(chunk: any, encoding?: string, cb?: (() => void)): <internal>.internal.PassThrough

Inherited from Transform.end
- Defined in node_modules/@types/node/stream.d.ts:242
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.end
- Defined in node_modules/@types/node/stream.d.ts:243
Parameters
- chunk: any
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough
Inherited from Transform.end
- Defined in node_modules/@types/node/stream.d.ts:244
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns <internal>.internal.PassThrough

cork

cork(): void

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

uncork

uncork(): void

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

_transform

_transform(chunk: any, encoding: string, callback: <internal>.internal.TransformCallback): void

Inherited from Transform._transform
- Defined in node_modules/@types/node/stream.d.ts:263
Parameters
- chunk: any
- encoding: string
- callback: <internal>.internal.TransformCallback
Returns void

_flush

_flush(callback: <internal>.internal.TransformCallback): void

Inherited from Transform._flush
- Defined in node_modules/@types/node/stream.d.ts:264
Parameters
- callback: <internal>.internal.TransformCallback
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

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

destroyed

destroyed: 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 PassThrough(opts?: <internal>.internal.TransformOptions): <internal>.internal.PassThrough

Inherited from Transform.constructor
- Defined in node_modules/@types/node/stream.d.ts:262
Parameters
- Optional opts: <internal>.internal.TransformOptions
Returns <internal>.internal.PassThrough

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>.internal.PassThrough

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.internal.PassThrough

setMaxListeners

Parameters

n: number

Returns <internal>.internal.PassThrough

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)[]

pipe

Type Parameters

T extends <internal>.WritableStream<T>

Parameters

destination: T

Optional options: { end?: boolean }

Optional end?: boolean

Returns T

Static from

Parameters

iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>

Optional options: <internal>.ReadableOptions

Returns <internal>.Readable

_read

Parameters

size: number

Returns void

read

Parameters

Optional size: number

Returns any

setEncoding

Parameters