Sanity Library Reference Docs
    Preparing search index...

    Interface ReadableOptions<T>

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

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    construct? destroy? read?

    Properties

    signal?: AbortSignal

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

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

    Methods

    • Parameters

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

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • this: T
      • size: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods