Class HookHandlerCli

Hook handler for a CLI command.

Hierarchy

HookHandler<HookCli>
- HookHandlerCli

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HookHandlerCli(): HookHandlerCli

Overrides HookHandler.constructor
- Defined in packages/hook-cli/lib/HookHandlerCli.ts:9
Returns HookHandlerCli

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

getDefaultParams

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

Overrides HookHandler.getDefaultParams
- Defined in packages/hook-cli/lib/HookHandlerCli.ts:13
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
Returns Record<string, any>

getSubHookNames

getSubHookNames(): string[]

Overrides HookHandler.getSubHookNames
- Defined in packages/hook-cli/lib/HookHandlerCli.ts:19
Names of possible sub-hooks into the hook.

Returns string[]

init

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

Overrides HookHandler.init
- Defined in packages/hook-cli/lib/HookHandlerCli.ts:23
Called upon initializing a new experiment.

Parameters
- experimentPaths: IExperimentPaths
- hookHandler: HookCli
Returns Promise<void>

Generated using TypeDoc