Class ExperimentHandler<E>

Handler for a certain type of experiment.

Type parameters

E: Experiment

Hierarchy

ExperimentHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExperimentHandler<E>(id: string, experimentClassName: string): ExperimentHandler<E>

- Defined in packages/jbr/lib/experiment/ExperimentHandler.ts:18
Type parameters
- E: Experiment
Parameters
- id: string
- experimentClassName: string
Returns ExperimentHandler<E>

Properties

Readonly experimentClassName

experimentClassName: string

Name of the experiment class. This will be used to initialize config files.

Readonly id

id: string

Unique id of this experiment type.

Methods

Abstract getDefaultParams

getDefaultParams(experimentPaths: IExperimentPaths): Record<string, any>

- Defined in packages/jbr/lib/experiment/ExperimentHandler.ts:28
Default parameters that should be added to the 'jbr-experiment.json' file during initialization. These should correspond to all (required) Components.js parameters for instantiating an experiment.

Parameters
- experimentPaths: IExperimentPaths
  
  The experiment directories. (guaranteed to exists)
Returns Record<string, any>

Abstract getHookNames

getHookNames(): string[]

- Defined in packages/jbr/lib/experiment/ExperimentHandler.ts:33
Names of possible hooks into the experiment.

Returns string[]

Abstract init

init(experimentPaths: IExperimentPaths, experiment: E): Promise<void>

- Defined in packages/jbr/lib/experiment/ExperimentHandler.ts:40
Called upon initializing a new experiment.

Parameters
- experimentPaths: IExperimentPaths
  
  The experiment directories. (guaranteed to exists)
- experiment: E
  
  The experiment instance.
Returns Promise<void>

Generated using TypeDoc