Skip to main content

BudgetOutcome

@forge/monorepo


@forge/monorepo / backend/src / BudgetOutcome

Type Alias: BudgetOutcome<T>

BudgetOutcome<T> = object

Defined in: backend/src/core/budget.ts:24

Type Parameters

T

T

Properties

budgetTokens

readonly budgetTokens: number

Defined in: backend/src/core/budget.ts:29


dropped

readonly dropped: readonly string[]

Defined in: backend/src/core/budget.ts:27

Names, in the order they were dropped. Named rather than counted: a count is not actionable.


overBudget

readonly overBudget: boolean

Defined in: backend/src/core/budget.ts:37

True when the budget could not be met even after dropping everything droppable.

Distinct from "it bound", because the two need different responses: a bound budget is the mechanism working, while an unmeetable one is a misconfiguration — the protected set alone does not fit, and a deployment that believes it capped its context has not.


resident

readonly resident: readonly T[]

Defined in: backend/src/core/budget.ts:25


residentTokens

readonly residentTokens: number

Defined in: backend/src/core/budget.ts:28