Trilium Backend API
    Preparing search index...

    Interface StreamOptions<T>

    interface StreamOptions<T extends Stream> {
        autoDestroy?: boolean;
        construct?: (this: T, callback: (error?: Error) => void) => void;
        destroy?: (
            this: T,
            error: Error,
            callback: (error?: Error) => void,
        ) => void;
        emitClose?: boolean;
        highWaterMark?: number;
        objectMode?: boolean;
        signal?: AbortSignal;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    autoDestroy? construct? destroy? emitClose? highWaterMark? objectMode? signal?

    Properties

    autoDestroy?: boolean
    construct?: (this: T, callback: (error?: Error) => void) => void
    destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
    emitClose?: boolean
    highWaterMark?: number
    objectMode?: boolean
    signal?: AbortSignal

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

    Settings

    Member Visibility

    On This Page

    Properties