API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
interfaceCoroutineOptions
@codexo/exojs / core / stable
4
props
0
methods
0
events
Import
import { CoroutineOptions } from '@codexo/exojs'Properties4
name?: stringLabel for diagnostics: it appears in the development warning about a step that overruns its slice, and makes CoroutineSystem's read surface legible to a debug overlay. Not a lookup key - the system exposes no retrieval by name, and Coroutine remains the handle.
priority?: numberFirst claim on the frame's slice; higher runs earlier. Once everything at the highest priority present has been stepped, whatever is left of the slice goes to the next priority down - priority decides order, not exclusive access. Coroutines of equal priority take turns across frames. Default 0, writable afterwards through Coroutine.priority.
Scope that owns the coroutine for as long as it runs: the system tracks it there on CoroutineSystem.queue and untracks it again on settlement, so a scene or screen destroyed mid-run cancels it without collecting every coroutine it ever started.
signal?: AbortSignalCancels the coroutine when it aborts, exactly as Coroutine.cancel does. For reaching an existing signal in - the one that also aborts a fetch, or the one a controller uses to tear several things down at once.
Source