UNPKG

1.17 kBTypeScriptView Raw
1import { IBuildConfig } from './IBuildConfig';
2/**
3 * @public
4 */
5export interface IExecutable {
6 /**
7 * The maximum amount of time the build can run before being terminated.
8 * Specified in milliseconds. By default, there is no timeout.
9 *
10 * If set to zero (0), the build will never time out.
11 *
12 * This option overrides the maxBuildTime property on the global build config.
13 */
14 maxBuildTimeMs?: number;
15 /**
16 * Helper function which is called one time when the task is registered
17 */
18 onRegister?: () => void;
19 /**
20 * Execution method.
21 */
22 execute: (config: IBuildConfig) => Promise<void>;
23 /**
24 * Optional name to give the task. If no name is provided, the "Running subtask" logging will be silent.
25 */
26 name?: string;
27 /**
28 * Optional callback to indicate if the task is enabled or not.
29 */
30 isEnabled?: (buildConfig: IBuildConfig) => boolean;
31 /**
32 * Optional method to indicate directory matches to clean up when the clean task is run.
33 */
34 getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
35}
36//# sourceMappingURL=IExecutable.d.ts.map
\No newline at end of file