apiBudgetError
apiBudgetError(
result,maxUsagePercent):SfError
Defined in: packages/simply-core/src/org/apiBudget.ts:148
Build the error thrown when a run does not fit its budget.
The numbers matter more than the prose — what the operator does next depends on how far over they are — so all four are named.
Parameters
Section titled “Parameters”result
Section titled “result”An exceeded result.
maxUsagePercent
Section titled “maxUsagePercent”number
The percentage that was applied, for the remediation hint.
Returns
Section titled “Returns”SfError
The error to throw.