HerdrUpdateDeps
Defined in: src/herdr-update.ts:106
Properties
Section titled “Properties”fetchLatest?
Section titled “fetchLatest?”
optionalfetchLatest?: () =>Promise<{notes?:string;version:string; }>
Defined in: src/herdr-update.ts:110
inject point for tests; defaults to fetching herdr.dev/latest.json
Returns
Section titled “Returns”Promise<{ notes?: string; version: string; }>
maintenance?
Section titled “maintenance?”
optionalmaintenance?:object
Defined in: src/herdr-update.ts:124
maintenance gate; defaults to the shared process singleton
begin()
Section titled “begin()”begin():
void
Returns
Section titled “Returns”void
end():
void
Returns
Section titled “Returns”void
onDone?
Section titled “onDone?”
optionalonDone?: (result) =>void
Defined in: src/herdr-update.ts:122
the terminal result, emitted exactly once per apply(); default: no-op
Parameters
Section titled “Parameters”result
Section titled “result”Returns
Section titled “Returns”void
onLog?
Section titled “onLog?”
optionalonLog?: (line) =>void
Defined in: src/herdr-update.ts:118
each log line streamed from the running update; default: no-op
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
onStatus?
Section titled “onStatus?”
optionalonStatus?: (status) =>void
Defined in: src/herdr-update.ts:120
the recomputed status after the update settles; default: no-op
Parameters
Section titled “Parameters”status
Section titled “status”Returns
Section titled “Returns”void
runUpdate?
Section titled “runUpdate?”
optionalrunUpdate?: (onLine,signal) =>Promise<void>
Defined in: src/herdr-update.ts:116
Run the update child, streaming each output line to onLine, resolving when
it exits. The AbortSignal fires on watchdog timeout — the default kills the
child. Default: spawn bash -lc <buildUpdateScript>.
Parameters
Section titled “Parameters”onLine
Section titled “onLine”(line) => void
signal
Section titled “signal”AbortSignal
Returns
Section titled “Returns”Promise<void>
versionRunner?
Section titled “versionRunner?”
optionalversionRunner?: () =>string
Defined in: src/herdr-update.ts:108
inject point for tests; defaults to running the herdr binary’s —version
Returns
Section titled “Returns”string
watchdogMs?
Section titled “watchdogMs?”
optionalwatchdogMs?:number
Defined in: src/herdr-update.ts:126
watchdog ceiling before a hung herdr update is force-killed (default 5min)