API Reference | fast-check | Property based testing framework
    Preparing search index...

    Interface SchedulerReportItem<TMetaData>

    Describe a task for the report produced by the scheduler

    Since 1.25.0

    interface SchedulerReportItem<TMetaData = unknown> {
        label: string;
        metadata?: TMetaData;
        outputValue?: string;
        schedulingType: "function" | "promise" | "sequence";
        status: "rejected" | "pending" | "resolved";
        taskId: number;
    }

    Type Parameters

    • TMetaData = unknown
    Index

    Properties

    label metadata? outputValue? schedulingType status taskId

    Properties

    label: string

    Label of the task

    Since 1.25.0

    metadata?: TMetaData

    Metadata linked when scheduling the task

    Since 1.25.0

    outputValue?: string

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

    Since 1.25.0

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

    How was this task scheduled?

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

    Since 1.25.0

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

    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

    Since 1.25.0

    taskId: number

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

    Since 1.25.0

    Settings

    Member Visibility

    On This Page

    Properties