ActivityPlug API / @activityplug/core / BudgetScope

Class: BudgetScope

Defined in: packages/core/src/security/budget.ts:91

Constructors

Constructor

new BudgetScope(options): BudgetScope

Defined in: packages/core/src/security/budget.ts:95

Parameters

options

BudgetScopeOptions

Returns

BudgetScope

Accessors

mode

Get Signature

get mode(): BudgetMode

Defined in: packages/core/src/security/budget.ts:115

Returns

BudgetMode

---

operation

Get Signature

get operation(): string

Defined in: packages/core/src/security/budget.ts:119

Returns

string

Methods

absorb()

absorb(snapshot): void

Defined in: packages/core/src/security/budget.ts:176

Parameters

snapshot

BudgetSnapshot

Returns

void

---

charge()

charge(dimension, amount?): void

Defined in: packages/core/src/security/budget.ts:145

Parameters

dimension

"bytes" | "reads" | "nodes" | "depth" | "requests" | "activeAllocations" | "concurrency" | "deadline"

amount?

number = 1

Returns

void

---

checkDeadline()

checkDeadline(): void

Defined in: packages/core/src/security/budget.ts:167

Returns

void

---

child()

child(limits?): BudgetScope

Defined in: packages/core/src/security/budget.ts:123

Parameters

limits?

BudgetLimits = {}

Returns

BudgetScope

---

reserve()

reserve(dimension, amount?): BudgetReservation

Defined in: packages/core/src/security/budget.ts:151

Parameters

dimension

"bytes" | "reads" | "nodes" | "depth" | "requests" | "activeAllocations" | "concurrency" | "deadline"

amount?

number = 1

Returns

BudgetReservation

---

snapshot()

snapshot(): BudgetSnapshot

Defined in: packages/core/src/security/budget.ts:233

Returns

BudgetSnapshot

---

watchDeadline()

watchDeadline(): BudgetDeadlineWatch

Defined in: packages/core/src/security/budget.ts:195

Returns

BudgetDeadlineWatch