Interface Experiment

Hierarchy

Experiment

Implemented by

Index

Methods

Methods

clean

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

- Defined in packages/jbr/lib/experiment/Experiment.ts:23
Called when an experiment 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/experiment/Experiment.ts:10
Called when data needs to be prepared for an experiment.

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

run

run(context: IRunTaskContext): Promise<void>

- Defined in packages/jbr/lib/experiment/Experiment.ts:16
Called when an experiment is executed.

Parameters
- context: IRunTaskContext
  
  The task context.
Returns Promise<void>

Generated using TypeDoc