Skip to main content

Interface: OperationalHooksConfig<T>

Defined in: electron/utils/operationalHooks.ts:71

Configuration for operational hooks.

Type Parameters​

T​

T = unknown

Properties​

backoff?​

optional backoff: "linear" | "exponential"

Defined in: electron/utils/operationalHooks.ts:77

Backoff strategy for retry delays.

Default Value​

"exponential";

context?​

optional context: UnknownRecord

Defined in: electron/utils/operationalHooks.ts:82

Context data to include in events.

emitEvents?​

optional emitEvents: boolean

Defined in: electron/utils/operationalHooks.ts:89

Whether to emit events for this operation.

Default Value​

true;

eventEmitter?​

optional eventEmitter: TypedEventBus<UptimeEvents>

Defined in: electron/utils/operationalHooks.ts:94

Event emitter for operation events.

initialDelay?​

optional initialDelay: number

Defined in: electron/utils/operationalHooks.ts:101

Initial delay between retries in milliseconds.

Default Value​

100;

maxRetries?​

optional maxRetries: number

Defined in: electron/utils/operationalHooks.ts:108

Maximum number of retry attempts.

Default Value​

3;

onFailure()?​

optional onFailure: (error: Error, attempts: number) => void | Promise<void>

Defined in: electron/utils/operationalHooks.ts:113

Callback when operation fails permanently.

Parameters​

error​

Error

attempts​

number

Returns​

void | Promise<void>

onRetry()?​

optional onRetry: (attempt: number, error: Error) => void | Promise<void>

Defined in: electron/utils/operationalHooks.ts:118

Callback when retry is attempted.

Parameters​

attempt​

number

error​

Error

Returns​

void | Promise<void>

onSuccess()?​

optional onSuccess: (result: T) => void | Promise<void>

Defined in: electron/utils/operationalHooks.ts:123

Callback when operation succeeds.

Parameters​

result​

T

Returns​

void | Promise<void>

operationName​

operationName: string

Defined in: electron/utils/operationalHooks.ts:128

Name of the operation for logging and event emission.

throwOnFailure?​

optional throwOnFailure: boolean

Defined in: electron/utils/operationalHooks.ts:135

Whether to throw on final failure.

Default Value​

true;