Skip to content

dependabit / monitor/src / DependencyConfig

Interface: DependencyConfig

Defined in: packages/monitor/src/monitor.ts:32

Runtime descriptor passed to the monitor for a single tracked dependency.

Remarks

Extends AccessConfig with identity, state-tracking, and monitoring rule fields. This is typically constructed by reading a DependencyEntry from a manifest and projecting the relevant fields.

Config

Pitfalls

  • currentStateHash must reflect the last known good state fetched by the monitor. An empty string or stale hash causes the first check to always report a change (false positive on first run).
  • lastChecked is used by the Scheduler to decide whether a dependency is due for checking. An incorrect or missing timestamp causes either perpetual over-checking (missing timestamp) or silent skipping (future timestamp).

Extends

Properties

PropertyTypeInherited fromDefined in
accessMethod"context7" | "arxiv" | "openapi" | "github-api" | "http"AccessConfig.accessMethodpackages/monitor/src/types.ts:71
auth?{ secret?: string; type: "token" | "oauth" | "basic" | "none"; }AccessConfig.authpackages/monitor/src/types.ts:72
auth.secret?string-packages/monitor/src/types.ts:74
auth.type"token" | "oauth" | "basic" | "none"-packages/monitor/src/types.ts:73
currentStateHashstring-packages/monitor/src/monitor.ts:36
currentVersion?string-packages/monitor/src/monitor.ts:37
idstring-packages/monitor/src/monitor.ts:33
lastChecked?string-packages/monitor/src/monitor.ts:38
monitoring?{ enabled?: boolean; ignoreChanges?: boolean; }-packages/monitor/src/monitor.ts:39
monitoring.enabled?boolean-packages/monitor/src/monitor.ts:40
monitoring.ignoreChanges?boolean-packages/monitor/src/monitor.ts:41
name?string-packages/monitor/src/monitor.ts:34
type?string-packages/monitor/src/monitor.ts:35
urlstringAccessConfig.urlpackages/monitor/src/types.ts:70

Released under the MIT License.