Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExperimentLoader

Loads and instantiates an experiment by config.

Hierarchy

  • ExperimentLoader

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ExperimentLoader(componentsManager: ComponentsManager<any>): ExperimentLoader

Properties

Private Readonly componentsManager

componentsManager: ComponentsManager<any>

Static Readonly COMBINATIONS_NAME

COMBINATIONS_NAME: "jbr-combinations.json" = 'jbr-combinations.json'

Static Readonly CONFIG_NAME

CONFIG_NAME: "jbr-experiment.json" = 'jbr-experiment.json'

Static Readonly CONFIG_TEMPLATE_NAME

CONFIG_TEMPLATE_NAME: "jbr-experiment.json.template" = 'jbr-experiment.json.template'

Static Readonly IRI_EXPERIMENT_HANDLER

IRI_EXPERIMENT_HANDLER: string = ...

Static Readonly IRI_HOOK_HANDLER

IRI_HOOK_HANDLER: string = ...

Static Readonly PACKAGEJSON_NAME

PACKAGEJSON_NAME: "package.json" = 'package.json'

Static Readonly PREPAREDMARKER_PATH

PREPAREDMARKER_PATH: string[] = ...

Methods

Protected discoverComponents

  • discoverComponents<C>(componentType: string): Promise<Record<string, { contexts: string[]; handler: C }>>

discoverExperimentHandlers

  • discoverExperimentHandlers(): Promise<Record<string, { contexts: string[]; handler: ExperimentHandler<any> }>>

discoverHookHandlers

  • discoverHookHandlers(): Promise<Record<string, { contexts: string[]; handler: HookHandler<any> }>>

instantiateCombinationProvider

  • instantiateCombinationProvider(experimentName: string, experimentPath: string): Promise<CombinationProvider>

instantiateExperiments

instantiateFromConfig

  • instantiateFromConfig<E>(configPath: string, experimentIri: string): Promise<E>

  • Instantiate an experiment from the given config file.

    Type parameters

    • E

    Parameters

    • configPath: string

      Path to an experiment configuration file.

    • experimentIri: string

      IRI of the experiment to instantiate.

    Returns Promise<E>

Static build

  • Create a new ExperimentLoader based on the given main module path.

    Type parameters

    • T

    Parameters

    • mainModulePath: string

      Path from which dependencies should be searched for. Typically the path of the current package.

    Returns Promise<ExperimentLoader>

Static buildComponentsManager

  • buildComponentsManager<T>(mainModulePath: string): Promise<ComponentsManager<T>>

Static getCombinationExperimentIri

  • getCombinationExperimentIri(experimentIri: string, combinationIdString: string): string

Static getCombinationIdString

  • getCombinationIdString(combinationId: number): string

Static getDefaultExperimentIri

  • getDefaultExperimentIri(experimentName: string): string

Static getExperimentName

  • getExperimentName(experimentRoot: string): Promise<string>

Static getPreparedMarkerPath

  • getPreparedMarkerPath(experimentPath: string): string

Static isCombinationsExperiment

  • isCombinationsExperiment(experimentPath: string): Promise<boolean>

  • Check if the given experiment path is a combinations-based experiment.

    throws

    if the combinations-based experiment is invalid.

    Parameters

    • experimentPath: string

      Path of an experiment.

    Returns Promise<boolean>

Static isExperimentPrepared

  • isExperimentPrepared(experimentPath: string): Promise<boolean>

Static requireCombinationsExperiment

  • requireCombinationsExperiment(experimentPath: string): Promise<void>

Static requireExperimentPrepared

  • requireExperimentPrepared(experimentPath: string): Promise<void>

Generated using TypeDoc