Skip to main content

Function: getExperiment()

function getExperiment(
  options: object,
): Promise<undefined | ExperimentResponseType>;
Defined in: src/utils/experiments.ts Gets an experiment by id or name. At least one of id or name must be provided.

Parameters

options

The options for getting an experiment.

id?

string (Optional) The id of the experiment.

name?

string (Optional) The name of the experiment.

projectName

string The name of the project.

Returns

Promise< | undefined | ExperimentResponseType> A promise that resolves to the experiment, or undefined if not found.