Limit | @msiviero/stream-utils

A transform stream that reduces the number of elements processed

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

Type parameters

T

the type of record passed down by previous streams

Hierarchy

Transform
- Limit

Implements

ReadableStream
Writable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Limit(limit: number, opts?: TransformOptions): Limit

Overrides Transform.__constructor
- Defined in src/transform.ts:218
Parameters
- limit: number
  
  The number of items after which the stream should end
- Default value opts: TransformOptions = {}
  
  The stream's options
Returns Limit

Properties

Private count

count: number = 0

destroyed

destroyed: boolean

Private limit

limit: number

The number of items after which the stream should end

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

readableObjectMode

readableObjectMode: boolean

writable

writable: boolean

writableCorked

writableCorked: number

writableEnded

writableEnded: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

writableObjectMode

writableObjectMode: boolean

Methods

[Symbol.asyncIterator]

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

Inherited from Splitter.[Symbol.asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:105
Returns AsyncIterableIterator<any>

_destroy

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

Inherited from Splitter._destroy

Overrides Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:238
Parameters
- error: Error | null
- callback: (error: Error | null) => void
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

_final

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

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

_flush

_flush(callback: TransformCallback): void

Inherited from Map._flush
- Defined in node_modules/@types/node/stream.d.ts:265
Parameters
- callback: TransformCallback
Returns void

_read

_read(size: number): void

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

_transform

_transform(object: T, _: string, callback: TransformCallback): void

Overrides Transform._transform
- Defined in src/transform.ts:228
Parameters
- object: T
- _: string
- callback: TransformCallback
Returns void

_write

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

Inherited from Splitter._write
- Defined in node_modules/@types/node/stream.d.ts:236
Parameters
- chunk: any
- encoding: string
- callback: (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 Splitter._writev
- Defined in node_modules/@types/node/stream.d.ts:237
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: "data", listener: (chunk: any) => void): this
addListener(event: "end", listener: () => void): this
addListener(event: "readable", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:56
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 this
Inherited from Splitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:57
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.addListener

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

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

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

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

cork

cork(): void

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

destroy

destroy(error?: Error): void

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

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 Splitter.emit

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:64
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Splitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:65
Parameters
- event: "end"
Returns boolean
Inherited from Splitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:66
Parameters
- event: "readable"
Returns boolean
Inherited from Splitter.emit

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:68
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?: undefined | string, cb?: undefined | (() => void)): void

Inherited from Splitter.end
- Defined in node_modules/@types/node/stream.d.ts:243
Parameters
- Optional cb: undefined | (() => void)
Returns void
Inherited from Splitter.end
- Defined in node_modules/@types/node/stream.d.ts:244
Parameters
- chunk: any
- Optional cb: undefined | (() => void)
Returns void
Inherited from Splitter.end
- Defined in node_modules/@types/node/stream.d.ts:245
Parameters
- chunk: any
- Optional encoding: undefined | 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

isPaused

isPaused(): boolean

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

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: "data", listener: (chunk: any) => void): this
on(event: "end", listener: () => void): this
on(event: "readable", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.on

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.on

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

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

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:75
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: "data", listener: (chunk: any) => void): this
once(event: "end", listener: () => void): this
once(event: "readable", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.once

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

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.once

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

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

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

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

pause

pause(): this

Inherited from Splitter.pause
- Defined in node_modules/@types/node/stream.d.ts:37
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: "data", listener: (chunk: any) => void): this
prependListener(event: "end", listener: () => void): this
prependListener(event: "readable", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.prependListener

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.prependListener

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

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

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:89
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: "data", listener: (chunk: any) => void): this
prependOnceListener(event: "end", listener: () => void): this
prependOnceListener(event: "readable", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.prependOnceListener

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

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.prependOnceListener

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

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

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

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

push

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

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

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

read

read(size?: undefined | number): any

Inherited from Splitter.read
- Defined in node_modules/@types/node/stream.d.ts:35
Parameters
- Optional size: undefined | number
Returns any

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: "data", listener: (chunk: any) => void): this
removeListener(event: "end", listener: () => void): this
removeListener(event: "readable", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Splitter.removeListener

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

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Splitter.removeListener

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

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

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

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

resume

resume(): this

Inherited from Splitter.resume
- Defined in node_modules/@types/node/stream.d.ts:38
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: string): this

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

setEncoding

setEncoding(encoding: string): this

Inherited from Splitter.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:36
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 Splitter.uncork
- Defined in node_modules/@types/node/stream.d.ts:247
Returns void

unpipe

unpipe(destination?: NodeJS.WritableStream): this

Inherited from Splitter.unpipe
- Defined in node_modules/@types/node/stream.d.ts:40
Parameters
- Optional destination: NodeJS.WritableStream
Returns this

unshift

unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from Splitter.unshift
- Defined in node_modules/@types/node/stream.d.ts:41
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): this

Inherited from Splitter.wrap
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- oldStream: ReadableStream
Returns this

write

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

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

Static from

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

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

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

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

limit: number

Default value opts: TransformOptions = {}

Returns Limit

Properties

Private count

destroyed

Private limit

readable

readableHighWaterMark

readableLength

readableObjectMode

writable

writableCorked

writableEnded

writableFinished

writableHighWaterMark

writableLength

writableObjectMode

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

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

Parameters

error: Error | null

Returns void

Returns void

_final

Parameters

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

Parameters

Optional error: Error | null

Returns void

Returns void

_flush

Parameters

callback: TransformCallback

Returns void

_read

Parameters

size: number

Returns void

_transform

Parameters

object: T

_: string

callback: TransformCallback

Returns void

_write

Parameters

chunk: any

encoding: string

callback: (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