Interface Hook

Hierarchy

Hook

Implemented by

Index

Methods

Methods

clean

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

- Defined in packages/jbr/lib/hook/Hook.ts:26
Called when a hook needs to be cleaned up.

Parameters
- context: ITaskContext
  
  The task context.
- cleanTargets: ICleanTargets
  
  What parts of the experiment that need cleaning.
Returns Promise<void>

prepare

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

- Defined in packages/jbr/lib/hook/Hook.ts:11
Called when data needs to be prepared for an experiment hook.

Parameters
- context: ITaskContext
  
  The task context.
- forceOverwriteGenerated: boolean
  
  If the generated directory should be overridden.
Returns Promise<void>

start

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

- Defined in packages/jbr/lib/hook/Hook.ts:19
Called to start an experiment hook.

Parameters
- context: ITaskContext
  
  The task context.
- Optional options: IHookStartOptions
  
  Custom start options.
Returns Promise<ProcessHandler>

A process handler.

Generated using TypeDoc