Interface CollectorTimeout

interface CollectorTimeout {
    ms: number;
    onTimeout?: (
        resolve: (value: AsyncOrSync<string[]>) => void,
        reject: (value: AsyncOrSync<string[]>) => void,
        partialResult: string[],
    ) => void;
    resetOnNewData: boolean;
    [key: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: unknown

Hierarchy-Diagram

UML class diagram of CollectorTimeout

Properties

ms onTimeout? resetOnNewData

Properties

ms

ms: number

number of milliseconds to wait for the collection to finish

OptionalonTimeout

onTimeout?: (
    resolve: (value: AsyncOrSync<string[]>) => void,
    reject: (value: AsyncOrSync<string[]>) => void,
    partialResult: string[],
) => void

invoked when the timeout is reached. If not set, the promise will be rejected with an error.

resetOnNewData

resetOnNewData: boolean

Settings

Member Visibility

On This Page

Properties