Tagscript

CheckWorkload

TagScript


Function: checkWorkload()

checkWorkload(charLimit, totalWork, output): number

Defined in: packages/tagscript/src/lib/Interpreter/engine.ts:47

Adds output to the running total and checks it against the limit.

Parameters

charLimit

number | null

The maximum number of characters a render may produce, or null for no limit.

totalWork

number

The number of characters produced so far.

output

string

The output about to be spliced in.

Returns

number

The new running total.

Throws

A WorkloadExceededError when the new total is over charLimit.

On this page