Class HookNonConfigured

A hook that always errors upon usage.

This hook should be used by default for hooks in new experiments, which have not been configured yet.

Hierarchy

HookNonConfigured

Implements

Hook

Index

Constructors

constructor

Methods

Constructors

constructor

new HookNonConfigured(): HookNonConfigured

Returns HookNonConfigured

Methods

clean

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

Implementation of Hook.clean
- Defined in packages/jbr/lib/hook/HookNonConfigured.ts:22
Called when a hook needs to be cleaned up.

Parameters
- context: ITaskContext
- cleanTargets: ICleanTargets
Returns Promise<void>

Protected makeError

makeError(): Error

- Defined in packages/jbr/lib/hook/HookNonConfigured.ts:26
Returns Error

prepare

prepare(context: ITaskContext): Promise<void>

Implementation of Hook.prepare
- Defined in packages/jbr/lib/hook/HookNonConfigured.ts:14
Called when data needs to be prepared for an experiment hook.

Parameters
- context: ITaskContext
Returns Promise<void>

start

start(context: ITaskContext): Promise<ProcessHandler>

Implementation of Hook.start
- Defined in packages/jbr/lib/hook/HookNonConfigured.ts:18
Called to start an experiment hook.

Parameters
- context: ITaskContext
Returns Promise<ProcessHandler>

A process handler.

Generated using TypeDoc