Skip to main content

Interface: SchedulerReportItem<TMetaData>

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:164

Describe a task for the report produced by the scheduler

Remarks​

Since 1.25.0

Type Parameters​

Type ParameterDefault type
TMetaDataunknown

Properties​

label​

label: string

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:192

Label of the task

Remarks​

Since 1.25.0

metadata?​

optional metadata?: TMetaData

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:197

Metadata linked when scheduling the task

Remarks​

Since 1.25.0

outputValue?​

optional outputValue?: string

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:202

Stringified version of the output or error computed using fc.stringify

Remarks​

Since 1.25.0

schedulingType​

schedulingType: "function" | "promise" | "sequence"

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:182

How was this task scheduled?

  • promise: schedule
  • function: scheduleFunction
  • sequence: scheduleSequence

Remarks​

Since 1.25.0

status​

status: "resolved" | "rejected" | "pending"

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:173

Execution status for this task

  • resolved: task released by the scheduler and successful
  • rejected: task released by the scheduler but with errors
  • pending: task still pending in the scheduler, not released yet

Remarks​

Since 1.25.0

taskId​

taskId: number

Defined in: packages/fast-check/src/arbitrary/_internals/interfaces/Scheduler.ts:187

Incremental id for the task, first received task has taskId = 1

Remarks​

Since 1.25.0