@ionic/utils-process

Variables

• ERROR_TIMEOUT_REACHED

Functions

• createProcessEnv()
• getPathParts()
• killProcessTree()
• offBeforeExit()
• onBeforeExit()
• onExit()
• processExit()
• sleep()
• sleepForever()
• sleepUntil()

Type Aliases

• ExitFn

variable ERROR_TIMEOUT_REACHED

const ERROR_TIMEOUT_REACHED: Error;

function createProcessEnv

createProcessEnv: (...sources: { [key: string]: string }[]) => NodeJS.ProcessEnv;

• Creates an alternative implementation of process.env object.

  On a Windows shell, process.env is a magic object that offers case-insensitive environment variable access. On other platforms, case sensitivity matters. This method creates an empty "process.env" object type that works for all platforms.

function getPathParts

getPathParts: (envpath?: string) => string[];

• Split a PATH string into path parts.

function killProcessTree

killProcessTree: (pid: number, signal?: string | number) => Promise<void>;

function offBeforeExit

offBeforeExit: (fn: ExitFn) => void;

• Remove a function that was registered with onBeforeExit.

function onBeforeExit

onBeforeExit: (fn: ExitFn) => void;

• Register an asynchronous function to be called when the process wants to exit.

  A handler will be registered for the 'SIGINT', 'SIGTERM', 'SIGHUP', 'SIGBREAK' signals. If any of the signal events is emitted, fn will be called exactly once, awaited upon, and then the process will exit once all registered functions are resolved.

function onExit

onExit: (fn: () => void) => void;

• Register a synchronous function to be called once the process exits.

function processExit

processExit: (exitCode?: number) => Promise<void>;

• Asynchronous process.exit(), for running functions registered with onBeforeExit.

function sleep

sleep: (ms: number) => Promise<void>;

• Resolves when the given amount of milliseconds has passed.

function sleepForever

sleepForever: () => Promise<never>;

• Never resolves and keeps Node running.

function sleepUntil

sleepUntil: (
    predicate: () => boolean,
    { interval, timeout }: { interval?: number; timeout?: number }
) => Promise<void>;

• Resolves when a given predicate is true or a timeout is reached.

  Configure interval to set how often the predicate is called.

  By default, timeout is Infinity. If given a value (in ms), and that timeout value is reached, this function will reject with the ERROR_TIMEOUT_REACHED error.

type ExitFn

type ExitFn = () => Promise<void>;