Reference/SDK/TypeScript/Interfaces

Interface: EvalHooks<Expected, Metadata, Parameters>

Type parameters

NameType
ExpectedExpected
Metadataextends BaseMetadata
Parametersextends EvalParameters

Properties

expected

expected: Expected

The expected output for the current evaluation.


meta

meta: (info: Metadata) => void

Type declaration

▸ (info): void

Parameters
NameType
infoMetadata
Returns

void

Deprecated

Use metadata instead.


metadata

metadata: Metadata extends void ? Record<string, unknown> : Metadata

The metadata object for the current evaluation. You can mutate this object to add or remove metadata.


parameters

parameters: InferParameters<Parameters>

The current parameters being used for this specific task execution. Array parameters are converted to single values.


reportProgress

reportProgress: (progress: TaskProgressEvent) => void

Type declaration

▸ (progress): void

Report progress that will show up in the playground.

Parameters
NameType
progressTaskProgressEvent
Returns

void


span

span: Span

The task's span.

On this page