Class ModelAttemptBudget

The per-call authorizer over a hold of the compound credit ledger.

Implements

IAttemptAuthorizer

Index

Constructors

Methods

authorize record

Constructors

constructor

new ModelAttemptBudget(options): ModelAttemptBudget
Parameters
- options: {
      store: ICompoundCreditStore;
      holdId: string;
      now?: (() => number);
  }
  The store, the call's hold, and the clock.
  - store: ICompoundCreditStore
  - holdId: string
  - Optional now?: (() => number)
    - (): number
      Returns number
Returns ModelAttemptBudget
- Defined in src/safety/runtime/ModelAttemptBudget.ts:205

Methods

authorize

authorize(request): Promise<AttemptGrant>
Authorizes the next attempt.
Parameters
- request: {
  purpose: AttemptPurpose;
  rateVersion?: string;
  }
  - purpose: AttemptPurpose
  - Optional rateVersion?: string
Returns Promise<AttemptGrant>
Throws
When the attempt is refused.
Implementation of IAttemptAuthorizer.authorize
- Defined in src/safety/runtime/ModelAttemptBudget.ts:211

record

record(attemptId, usage, final): Promise<void>
Records an attempt's quantities by component key.
Parameters
- attemptId: string
- usage: Readonly<Record<string, number>>
- final: boolean
Returns Promise<void>
Implementation of IAttemptAuthorizer.record
- Defined in src/safety/runtime/ModelAttemptBudget.ts:218