MacPro
27 lines
1.4 KiB
TypeScript
27 lines
1.4 KiB
TypeScript
import * as T from '../../../base/lib/types';
|
|
/**
|
|
* The reason a service's init function is being called:
|
|
* - `'install'` — first-time installation
|
|
* - `'update'` — after a package update
|
|
* - `'restore'` — after restoring from backup
|
|
* - `null` — regular startup (no special lifecycle event)
|
|
*/
|
|
export type InitKind = 'install' | 'update' | 'restore' | null;
|
|
/** Function signature for an init handler that runs during service startup. */
|
|
export type InitFn<Kind extends InitKind = InitKind> = (effects: T.Effects, kind: Kind) => Promise<void | null | undefined>;
|
|
/** Object form of an init handler — implements an `init()` method. */
|
|
export interface InitScript<Kind extends InitKind = InitKind> {
|
|
init(effects: T.Effects, kind: Kind): Promise<void>;
|
|
}
|
|
/** Either an {@link InitScript} object or an {@link InitFn} function. */
|
|
export type InitScriptOrFn<Kind extends InitKind = InitKind> = InitScript<Kind> | InitFn<Kind>;
|
|
/**
|
|
* Composes multiple init handlers into a single `ExpectedExports.init`-compatible function.
|
|
* Handlers are executed sequentially in the order provided.
|
|
*
|
|
* @param inits - One or more init handlers to compose
|
|
*/
|
|
export declare function setupInit(...inits: InitScriptOrFn[]): T.ExpectedExports.init;
|
|
/** Normalizes an {@link InitScriptOrFn} into an {@link InitScript} object. */
|
|
export declare function setupOnInit(onInit: InitScriptOrFn): InitScript;
|