Interface SliceStreamOptions

interface SliceStreamOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    end?: number;
    highWaterMark?: number;
    objectMode?: boolean;
    readableHighWaterMark?: number;
    readableObjectMode?: boolean;
    signal?: AbortSignal;
    size?: number;
    start: number;
    writableCorked?: number;
    writableHighWaterMark?: number;
    writableObjectMode?: boolean;
    construct?(this: Transform, callback: ((error?: null | Error) => void)): void;
    destroy?(this: Transform, error: null | Error, callback: ((error: null | Error) => void)): void;
    final?(this: Transform, callback: ((error?: null | Error) => void)): void;
    flush?(this: Transform, callback: TransformCallback): void;
    read?(this: Transform, size: number): void;
    transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
    write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: ((error?: null | Error) => void)): void;
    writev?(this: Transform, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: ((error?: null | Error) => void)): void;
}

Hierarchy

  • TransformOptions
    • SliceStreamOptions

Properties

allowHalfOpen? autoDestroy? decodeStrings? defaultEncoding? emitClose? encoding? end? highWaterMark? objectMode? readableHighWaterMark? readableObjectMode? signal? size? start writableCorked? writableHighWaterMark? writableObjectMode?

Methods

construct? destroy? final? flush? read? transform? write? writev?

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalautoDestroy

autoDestroy?: boolean

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalemitClose

emitClose?: boolean

Optionalencoding

encoding?: BufferEncoding

Optionalend

end?: number

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

OptionalreadableHighWaterMark

readableHighWaterMark?: number

OptionalreadableObjectMode

readableObjectMode?: boolean

Optionalsignal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

Optionalsize

size?: number

start

start: number

OptionalwritableCorked

writableCorked?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

OptionalwritableObjectMode

writableObjectMode?: boolean

Methods

Optionalconstruct

  • construct(this, callback): void

  • Parameters

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

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionaldestroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Optionalfinal

  • final(this, callback): void

  • Parameters

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

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionalflush

  • flush(this, callback): void

  • Parameters

    • this: Transform
    • callback: TransformCallback

    Returns void

Optionalread

  • read(this, size): void

  • Parameters

    • this: Transform
    • size: number

    Returns void

Optionaltransform

  • transform(this, chunk, encoding, callback): void

  • Parameters

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

    Returns void

Optionalwrite

  • write(this, chunk, encoding, callback): void

  • Parameters

    • this: Transform
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionalwritev

  • writev(this, chunks, callback): void

  • Parameters

    • this: Transform
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods