ts-lambda-api - v2.5.2
    Preparing search index...

    Interface ReadableOptions<T>

    interface ReadableOptions<T extends Readable = Readable> {
        autoDestroy?: boolean;
        emitClose?: boolean;
        encoding?: BufferEncoding;
        highWaterMark?: number;
        objectMode?: boolean;
        signal?: AbortSignal;
        construct(this: T, callback: (error?: Error) => void): void;
        destroy(this: T, error: Error, callback: (error?: Error) => void): void;
        read(this: T, size: number): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    autoDestroy? emitClose? encoding? highWaterMark? objectMode? signal?

    Methods

    construct? destroy? read?

    Properties

    autoDestroy?: boolean
    emitClose?: boolean
    encoding?: BufferEncoding
    highWaterMark?: number
    objectMode?: boolean
    signal?: AbortSignal

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

    Methods

    • Parameters

      • this: T
      • callback: (error?: Error) => void

      Returns void

    • Parameters

      • this: T
      • error: Error
      • callback: (error?: Error) => void

      Returns void

    • Parameters

      • this: T
      • size: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods