@compas/cli/src/watcher/index.d.ts

CLI containing utilities and simple script runner

/**
 * Kill a sub process with its own sub processes.
 * Uses tree-kill under the hood, to also exit any child processes of the provided process
 *
 * @param {import("child_process").ChildProcess} process
 * @param {NodeJS.Signals | number} signal
 * @returns {Promise<void>}
 */
export function watcherKillProcess(process: import("child_process").ChildProcess, signal: NodeJS.Signals | number): Promise<void>;
/**
 * Run watcher with the provided chokidar options, calling the hooks
 *
 * @param {{
 *   chokidarOptions: import("chokidar").WatchOptions,
 *   hooks: {
 *     onRestart: () => void,
 *   }
 * }} options
 * @returns {Promise<{ closeWatcher: () => Promise<void> }>}
 */
export function watcherRun({ chokidarOptions, hooks }: {
    chokidarOptions: import("chokidar").WatchOptions;
    hooks: {
        onRestart: () => void;
    };
}): Promise<{
    closeWatcher: () => Promise<void>;
}>;
/**
 * Run watcher run & wrap around child process spawn.
 * Makes sure the instance is fully killed, before starting up again.
 *
 * @param {import("@compas/stdlib").Logger} logger
 * @param {{
 *   chokidarOptions: import("chokidar").WatchOptions,
 *   spawnArguments: [
 *     string,
 *     ReadonlyArray<string>,
 *     import("child_process").SpawnOptions,
 *   ],
 * }} options
 */
export function watcherRunWithSpawn(logger: import("@compas/stdlib").Logger, options: {
    chokidarOptions: import("chokidar").WatchOptions;
    spawnArguments: [string, ReadonlyArray<string>, import("child_process").SpawnOptions];
}): Promise<void>;