Function evaluateExperiment

Parameters

• __namedParameters: {
      client?: {
          config: ClientOptions;
          DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
          GET: ClientMethod<paths, "get", `${string}/${string}`>;
          HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
          OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
          PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
          POST: ClientMethod<paths, "post", `${string}/${string}`>;
          PUT: ClientMethod<paths, "put", `${string}/${string}`>;
          TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
          eject(...middleware: Middleware[]): void;
          use(...middleware: Middleware[]): void;
      };
      concurrency?: number;
      diagLogLevel?: DiagLogLevel;
      dryRun?: number
      | boolean;
      evaluators: ExperimentEvaluatorLike[];
      experiment: RanExperiment;
      logger?: Logger;
      setGlobalTracerProvider?: boolean;
      tracerProvider?: NodeTracerProvider | null;
      useBatchSpanProcessor?: boolean;
  }

  • Optionalclient?: {
        config: ClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
        OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
        PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
        POST: ClientMethod<paths, "post", `${string}/${string}`>;
        PUT: ClientMethod<paths, "put", `${string}/${string}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    }

    The client to use

    • config: ClientOptions

    • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

      Call a DELETE endpoint

    • GET: ClientMethod<paths, "get", `${string}/${string}`>

      Call a GET endpoint

    • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

      Call a HEAD endpoint

    • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

      Call a OPTIONS endpoint

    • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

      Call a PATCH endpoint

    • POST: ClientMethod<paths, "post", `${string}/${string}`>

      Call a POST endpoint

    • PUT: ClientMethod<paths, "put", `${string}/${string}`>

      Call a PUT endpoint

    • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

      Call a TRACE endpoint

    • eject: function

      • eject(...middleware: Middleware[]): void

        Unregister middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    • use: function

      • use(...middleware: Middleware[]): void

        Register middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

  • Optionalconcurrency?: number

    The number of evaluators to run in parallel

  • OptionaldiagLogLevel?: DiagLogLevel

    Log level to set for the default DiagConsoleLogger when tracing. Omit to disable default diag logging, or to bring your own.

  • OptionaldryRun?: number | boolean

    Whether to run the evaluation as a dry run If a number is provided, the evaluation will be run for the first n runs

    Default

    false
    Copy

  • evaluators: ExperimentEvaluatorLike[]

    The evaluators to use

  • experiment: RanExperiment

    The experiment to evaluate

  • Optionallogger?: Logger

    The logger to use

  • OptionalsetGlobalTracerProvider?: boolean

    Whether to set the global tracer provider when running the evaluators

    Default

    true
    Copy

  • OptionaltracerProvider?: NodeTracerProvider | null

    The tracer provider to use. If set, the other parameters will be ignored and the passed tracer provider will get used Intended as a pass-through from runExperiment

  • OptionaluseBatchSpanProcessor?: boolean

    Whether to use batching for the span processor.

    Default

    true
    Copy