A stream that slices a part out of another stream. start and end are inclusive. If end is not defined it is until the end of the stream.

Negative start values can be used to instead slice that many streams off the end of the stream. This requires the size field to be defined.

Both object and non-object streams are supported. This needs to be explicitly specified, as the class makes no assumptions based on the object mode of the source stream.

Hierarchy

  • Transform
    • SliceStream

Constructors

Properties

allowHalfOpen: boolean
destroyed: boolean
readable: boolean
readableEncoding: null | BufferEncoding
readableEnded: boolean
readableFlowing: null | boolean
readableHighWaterMark: number
readableLength: number
readableObjectMode: boolean
remainingRead: number
remainingSkip: number
source: Readable
writable: boolean
writableCorked: number
writableEnded: boolean
writableFinished: boolean
writableHighWaterMark: number
writableLength: number
writableObjectMode: boolean
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
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.

Methods

  • Returns AsyncIterableIterator<any>

  • Parameters

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

          • error: null | Error

          Returns void

    Returns void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • callback: TransformCallback

    Returns void

  • Parameters

    • size: number

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: TransformCallback

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Event emitter The defined events on documents including:

    1. close
    2. data
    3. drain
    4. end
    5. error
    6. finish
    7. pause
    8. pipe
    9. readable
    10. resume
    11. unpipe

    Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Stop piping the source stream and close everything once the slice is finished.

    Returns void

  • Returns void

  • Parameters

    • Optional error: Error

    Returns SliceStream

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "pipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: "unpipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • chunk: any
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Returns (string | symbol)[]

  • Returns number

  • Returns boolean

  • Parameters

    • event: string | symbol

    Returns number

  • Parameters

    • event: string | symbol

    Returns Function[]

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Returns SliceStream

  • Type Parameters

    • T extends WritableStream<T>

    Parameters

    • destination: T
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns T

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns boolean

  • Parameters

    • event: string | symbol

    Returns Function[]

  • Parameters

    • Optional size: number

    Returns any

  • Parameters

    • Optional event: string | symbol

    Returns SliceStream

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void
        • Parameters

          • chunk: any

          Returns void

    Returns SliceStream

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns SliceStream

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns SliceStream

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns SliceStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SliceStream

  • Returns SliceStream

  • Parameters

    • encoding: BufferEncoding

    Returns SliceStream

  • Parameters

    • encoding: BufferEncoding

    Returns SliceStream

  • Parameters

    • n: number

    Returns SliceStream

  • Returns void

  • Parameters

    • Optional destination: WritableStream

    Returns SliceStream

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

  • Parameters

    • oldStream: ReadableStream

    Returns SliceStream

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: ((error) => void)
        • (error): void
        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • Parameters

    • chunk: any
    • Optional cb: ((error) => void)
        • (error): void
        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • A utility method for creating Readable Streams out of iterators.

    Parameters

    • iterable: Iterable<any> | AsyncIterable<any>
    • Optional options: ReadableOptions

    Returns Readable

  • Deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>