API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceFrameBudget

@codexo/exojs / core / stable

How much of the running frame is still unspent, handed to the SystemMethods.postFrame phase. Modelled on the platform's `IdleDeadline`, so the canonical loop is the one the browser already teaches: ```ts while (budget.timeRemaining() > 0 && queue.length > 0) { doWork(); } ``` The figure is advisory. JavaScript is run-to-completion, so nothing can interrupt a unit of work that overruns - the budget tells work that polls it when to stop, and work that ignores it is unaffected.

0
props
1
methods
0
events
Import
import { FrameBudget } from '@codexo/exojs'

How much of the running frame is still unspent, handed to the SystemMethods.postFrame phase.

Modelled on the platform's `IdleDeadline`, so the canonical loop is the one the browser already teaches:

```ts while (budget.timeRemaining() > 0 && queue.length > 0) { doWork(); } ```

The figure is advisory. JavaScript is run-to-completion, so nothing can interrupt a unit of work that overruns - the budget tells work that polls it when to stop, and work that ignores it is unaffected.

Methods1
timeRemaining(): SecondsA length of time in seconds. The unit every duration in the public API is expressed in - frame deltas, the fixed step, elapsed totals, timer limits. It is a `nā€¦
Time left before the current frame reaches its target duration, clamped at zero. A live view of the running frame, updated in place - holding it across a yield and reading it again in a later frame is the intended pattern, not a mistake. Outside a frame it reports zero.
Source
src/core/FrameBudget.ts