Class Workload<TWork>

A workload able to perform a work within a workbench.

The work specific to workload is represented by work instances. Such instances are available in * workbench and can be used e.g. to run workload-specific tasks.

The same workload instance can be used in different workbenches.

Type Parameters

  • TWork

    A work type performed by this workload.

Hierarchy

Constructors

constructor

Properties

allocator name

Methods

toString workName

Constructors

constructor

Properties

Readonly allocator

allocator: Workload.Allocator<TWork>

Work allocator.

Readonly name

name: string

Human-readable workload name.

Methods

toString

workName

  • Builds a human-readable name of the work performed by this workload.

    This is used e.g. to construct a default error message for WorkDoneError.

    Parameters

    • Optional _work: TWork

      Target work.

    Returns string

    A string containing work name.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc