Interface MetricsRoutesOptions

interface MetricsRoutesOptions {
    jobs: JobService;
    keepAliveMs?: number;
    minIntervalMs?: number;
    now?: () => number;
    signal?: AbortSignal;
    storage: Pick<StorageService, "path">;
    store: MetricsStore;
    timers?: StreamTimers;
    onChange(listener: () => void): Unsubscribe;
}

Index

Properties

jobs keepAliveMs? minIntervalMs? now? signal? storage store timers?

Methods

Properties

jobs

jobs: JobService

`Optional`keepAliveMs

keepAliveMs?: number

Milliseconds between comment frames that keep an idle connection open. Default 15 000.

`Optional`minIntervalMs

minIntervalMs?: number

Fewest milliseconds between two snapshots on one stream. Default 500.

`Optional`now

now?: () => number

`Optional`signal

signal?: AbortSignal

Aborts when the host stops the module; open streams end.

storage

storage: Pick<StorageService, "path">

store

store: MetricsStore

`Optional`timers

timers?: StreamTimers

Methods

onChange

onChange(listener: () => void): Unsubscribe
Calls listener after the store changed; how the stream learns to send.
Parameters
- listener: () => void
Returns Unsubscribe
- Defined in packages/module-metrics/src/routes.ts:21