Interface ReadableOptions

interface ReadableOptions {
    autoDestroy?: boolean;
    encoding?: string;
    highWaterMark?: number;
    objectMode?: boolean;
    destroy?(this, error, callback): void;
    read?(this, size): void;
}

Hierarchy

Properties

autoDestroy? encoding? highWaterMark? objectMode?

Methods

destroy? read?

Properties

Optional autoDestroy

autoDestroy?: boolean

Optional encoding

encoding?: string

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Methods

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          Returns void

    Returns void

Optional read

  • read(this, size): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page