Collect | @msiviero/stream-utils

A writable stream that acts a collector for previous operations results and provides an "close" event to act on them after finshed

Readable
 .from([1, 2, 3, 4])
 .pipe(new Collect())
 .on("close", (chunks: string[]) => {
     console.log(chunks); // [1,2,3,4]
 });

Type parameters

T

the type of record passed down by previous streams

Hierarchy

Writable
- Collect

Implements

WritableStream

Index

Constructors

constructor

Properties

Constructors

constructor

new Collect(): Collect

Overrides Writable.__constructor
- Defined in src/sink.ts:20
Returns Collect

Properties

Private #chunks

#chunks: T[] = []

destroyed

destroyed: boolean

writable

writable: boolean

writableCorked

writableCorked: number

writableEnded

writableEnded: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

writableObjectMode

writableObjectMode: boolean

Methods

_destroy

_destroy(error: Error | null, callback: (error?: Error | null) => void): void

Inherited from Collect._destroy
- Defined in node_modules/@types/node/stream.d.ts:133
Parameters
- error: Error | null
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_final

_final(done: (error?: Error | null) => void): void

Overrides Writable._final
- Defined in src/sink.ts:31
Parameters
- done: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_write

_write(chunk: T, _: string, done: (error?: Error | null) => void): void

Overrides Writable._write
- Defined in src/sink.ts:26
Parameters
- chunk: T
- _: string
- done: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<{ chunk: any; encoding: string }>, callback: (error?: Error | null) => void): void

Inherited from Collect._writev
- Defined in node_modules/@types/node/stream.d.ts:132
Parameters
- chunks: Array<{ chunk: any; encoding: string }>
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: () => void): this
addListener(event: "drain", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "finish", listener: () => void): this
addListener(event: "pipe", listener: (src: Readable) => void): this
addListener(event: "unpipe", listener: (src: Readable) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:155
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:156
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:157
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:158
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:159
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:160
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:161
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cork

cork(): void

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

destroy

destroy(error?: Error): void

Inherited from Collect.destroy
- Defined in node_modules/@types/node/stream.d.ts:143
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "drain"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: Readable): boolean
emit(event: "unpipe", src: Readable): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:163
Parameters
- event: "close"
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:164
Parameters
- event: "drain"
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:165
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:166
Parameters
- event: "finish"
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:167
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:168
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Inherited from Collect.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:169
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(cb?: undefined | (() => void)): void
end(chunk: any, cb?: undefined | (() => void)): void
end(chunk: any, encoding: string, cb?: undefined | (() => void)): void

Inherited from Collect.end
- Defined in node_modules/@types/node/stream.d.ts:138
Parameters
- Optional cb: undefined | (() => void)
Returns void
Inherited from Collect.end
- Defined in node_modules/@types/node/stream.d.ts:139
Parameters
- chunk: any
- Optional cb: undefined | (() => void)
Returns void
Inherited from Collect.end
- Defined in node_modules/@types/node/stream.d.ts:140
Parameters
- chunk: any
- encoding: string
- Optional cb: undefined | (() => void)
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from Splitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:562
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

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

listenerCount

listenerCount(type: string | symbol): number

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

listeners

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

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

off

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

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

on

on(event: "close", listener: () => void): this
on(event: "drain", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: "finish", listener: () => void): this
on(event: "pipe", listener: (src: Readable) => void): this
on(event: "unpipe", listener: (src: Readable) => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:171
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:172
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:173
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:174
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:175
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:176
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:177
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: () => void): this
once(event: "drain", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "finish", listener: () => void): this
once(event: "pipe", listener: (src: Readable) => void): this
once(event: "unpipe", listener: (src: Readable) => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:180
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pipe

pipe<T>(destination: T, options?: undefined | { end?: undefined | false | true }): T

Inherited from Splitter.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | { end?: undefined | false | true }
Returns T

prependListener

prependListener(event: "close", listener: () => void): this
prependListener(event: "drain", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "finish", listener: () => void): this
prependListener(event: "pipe", listener: (src: Readable) => void): this
prependListener(event: "unpipe", listener: (src: Readable) => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:188
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:189
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:191
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:192
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: () => void): this
prependOnceListener(event: "drain", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "finish", listener: () => void): this
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:196
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:197
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:198
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:199
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:200
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:201
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Splitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: () => void): this
removeListener(event: "drain", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: "finish", listener: () => void): this
removeListener(event: "pipe", listener: (src: Readable) => void): this
removeListener(event: "unpipe", listener: (src: Readable) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:203
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:204
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:205
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:206
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:207
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:208
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Collect.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:209
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: string): this

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from Splitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns this

uncork

uncork(): void

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

write

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

Inherited from Collect.write
- Defined in node_modules/@types/node/stream.d.ts:135
Parameters
- chunk: any
- Optional cb: undefined | ((error: Error | null | undefined) => void)
Returns boolean
Inherited from Collect.write
- Defined in node_modules/@types/node/stream.d.ts:136
Parameters
- chunk: any
- encoding: string
- Optional cb: undefined | ((error: Error | null | undefined) => void)
Returns boolean

written

written(): T[]

- Defined in src/sink.ts:36
Returns T[]

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Collect

Properties

Private #chunks

destroyed

writable

writableCorked

writableEnded

writableFinished

writableHighWaterMark

writableLength

writableObjectMode

Methods

_destroy

Parameters

error: Error | null

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

_final

Parameters

done: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

_write

Parameters

chunk: T

_: string

done: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<{ chunk: any; encoding: string }>

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "drain"

listener: () => void

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"

listener: () => void

Returns void

Returns this

Parameters

event: "pipe"

listener: (src: Readable) => void