Class HookHandler<H>

Handler for a certain type of experiment hook.

Type parameters

H: Hook

Hierarchy

HookHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HookHandler<H>(id: string, hookClassName: string): HookHandler<H>

- Defined in packages/jbr/lib/hook/HookHandler.ts:19
Type parameters
- H: Hook
Parameters
- id: string
- hookClassName: string
Returns HookHandler<H>

Properties

Readonly hookClassName

hookClassName: string

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

Readonly id

id: string

Unique id of this experiment hook type.

Methods

Abstract getDefaultParams

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

- Defined in packages/jbr/lib/hook/HookHandler.ts:29
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 getSubHookNames

getSubHookNames(): string[]

- Defined in packages/jbr/lib/hook/HookHandler.ts:34
Names of possible sub-hooks into the hook.

Returns string[]

Abstract init

init(experimentPaths: IExperimentPaths, hookHandler: H): Promise<void>

- Defined in packages/jbr/lib/hook/HookHandler.ts:41
Called upon initializing a new experiment.

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

Generated using TypeDoc