Interface DefaultTimerOptions

Hierarchy

  • DefaultTimerOptions

Properties

defaultOptions? log? maxConcurrentSpans? maxEntryHistory? time?

Properties

Optional defaultOptions

defaultOptions?: TimerEntryOptions

The default options to use for each timer entry.

Optional log

log?: ((entry) => void)

Type declaration

    • (entry): void

    • The function used to log start and end events.

      Parameters

      • entry: {
            context?: string;
            duration?: number;
            event: "start" | "end";
            id?: string;
            label: string;
            timestamp: number;
        }
        • Optional context?: string
        • Optional duration?: number
        • event: "start" | "end"
        • Optional id?: string
        • label: string
        • timestamp: number

      Returns void

Optional maxConcurrentSpans

maxConcurrentSpans?: number

The maximum number of in-progress timespans to hold in memory before evicting the oldest. Defaults to 500.

Optional maxEntryHistory

maxEntryHistory?: number

The maximum number of historical entries to hold in memory before evicting the oldest. Invoke .takeEntries() regularly to process timing. Defaults to 1000.

Optional time

time?: TimeController

The object used to determine the current time.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc