Class HookCli

A hook instance for a CLI-based hook.

Hierarchy

HookCli

Implements

Hook

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HookCli(entrypoint: string[], statsFilePath?: string): HookCli

- Defined in packages/hook-cli/lib/HookCli.ts:14
Parameters
- entrypoint: string[]
- Optional statsFilePath: string
Returns HookCli

Properties

Readonly entrypoint

entrypoint: string[]

Optional Readonly statsFilePath

statsFilePath: string

Methods

clean

clean(context: ITaskContext, cleanTargets: ICleanTargets): Promise<void>

Implementation of Hook.clean
- Defined in packages/hook-cli/lib/HookCli.ts:36
Called when a hook needs to be cleaned up.

Parameters
- context: ITaskContext
- cleanTargets: ICleanTargets
Returns Promise<void>

prepare

prepare(context: ITaskContext, forceOverwriteGenerated: boolean): Promise<void>

Implementation of Hook.prepare
- Defined in packages/hook-cli/lib/HookCli.ts:22
Called when data needs to be prepared for an experiment hook.

Parameters
- context: ITaskContext
- forceOverwriteGenerated: boolean
Returns Promise<void>

start

start(context: ITaskContext, options?: IHookStartOptions): Promise<ProcessHandler>

Implementation of Hook.start
- Defined in packages/hook-cli/lib/HookCli.ts:26
Called to start an experiment hook.

Parameters
- context: ITaskContext
- Optional options: IHookStartOptions
Returns Promise<ProcessHandler>

Generated using TypeDoc