Fix StartOS 0.4 TypeScript packaging to match SDK API
This commit is contained in:
+40
@@ -0,0 +1,40 @@
|
||||
import { Effects, HealthCheckId } from '../../../base/lib/types';
|
||||
import { HealthCheckResult } from './checkFns/HealthCheckResult';
|
||||
import { Trigger } from '../trigger';
|
||||
import { Drop } from '../util';
|
||||
/** Parameters for creating a health check */
|
||||
export type HealthCheckParams = {
|
||||
id: HealthCheckId;
|
||||
name: string;
|
||||
trigger?: Trigger;
|
||||
gracePeriod?: number;
|
||||
fn(): Promise<HealthCheckResult> | HealthCheckResult;
|
||||
};
|
||||
/**
|
||||
* A periodic health check that reports daemon readiness to the StartOS UI.
|
||||
*
|
||||
* Polls at an interval controlled by a {@link Trigger}, reporting results as
|
||||
* "starting" (during the grace period), "success", or "failure". Automatically
|
||||
* pauses when the daemon is stopped and resumes when restarted.
|
||||
*/
|
||||
export declare class HealthCheck extends Drop {
|
||||
private started;
|
||||
private setStarted;
|
||||
private exited;
|
||||
private exit;
|
||||
private currentValue;
|
||||
private promise;
|
||||
private constructor();
|
||||
/**
|
||||
* Create a new HealthCheck instance and begin its polling loop.
|
||||
* @param effects - The effects context for reporting health status
|
||||
* @param options - Health check configuration (ID, name, check function, trigger, grace period)
|
||||
* @returns A new HealthCheck instance
|
||||
*/
|
||||
static of(effects: Effects, options: HealthCheckParams): HealthCheck;
|
||||
/** Signal that the daemon is running, enabling health check polling */
|
||||
start(): void;
|
||||
/** Signal that the daemon has stopped, pausing health check polling */
|
||||
stop(): void;
|
||||
onDrop(): void;
|
||||
}
|
||||
Reference in New Issue
Block a user