Scheduler.ts overview
Since v2.0.0
Exports Grouped by Category
- constructors
- models
- schedulers
- utilities
- utils
constructors
ControlledScheduler (class)
Signature
declare class ControlledScheduler
Since v2.0.0
scheduleTask (method)
Signature
declare const scheduleTask: (task: Task, priority: number) => void
Since v2.0.0
shouldYield (method)
Signature
declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false
Since v2.0.0
step (method)
Signature
declare const step: () => void
Since v2.0.0
tasks (property)
Signature
tasks: PriorityBuckets<Task>
Since v2.0.0
deferred (property)
Signature
deferred: boolean
Since v2.0.0
MixedScheduler (class)
Signature
declare class MixedScheduler { constructor(
/**
* @since 2.0.0
*/
readonly maxNextTickBeforeTimer: number
) }
Since v2.0.0
starveInternal (method)
Signature
declare const starveInternal: (depth: number) => void
Since v2.0.0
starve (method)
Signature
declare const starve: (depth?: number) => void
Since v2.0.0
shouldYield (method)
Signature
declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false
Since v2.0.0
scheduleTask (method)
Signature
declare const scheduleTask: (task: Task, priority: number) => void
Since v2.0.0
running (property)
Signature
running: boolean
Since v2.0.0
tasks (property)
Signature
tasks: PriorityBuckets<Task>
Since v2.0.0
SyncScheduler (class)
Signature
declare class SyncScheduler
Since v2.0.0
scheduleTask (method)
Signature
declare const scheduleTask: (task: Task, priority: number) => void
Since v2.0.0
shouldYield (method)
Signature
declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false
Since v2.0.0
flush (method)
Signature
declare const flush: () => void
Since v2.0.0
tasks (property)
Signature
tasks: PriorityBuckets<Task>
Since v2.0.0
deferred (property)
Signature
deferred: boolean
Since v2.0.0
make
Signature
declare const make: (scheduleTask: Scheduler["scheduleTask"], shouldYield?: Scheduler["shouldYield"]) => Scheduler
Since v2.0.0
makeBatched
Signature
declare const makeBatched: (
callback: (runBatch: () => void) => void,
shouldYield?: Scheduler["shouldYield"]
) => Scheduler
Since v2.0.0
makeMatrix
Signature
declare const makeMatrix: (...record: Array<[number, Scheduler]>) => Scheduler
Since v2.0.0
timer
Signature
declare const timer: (ms: number, shouldYield?: Scheduler["shouldYield"]) => Scheduler
Since v2.0.0
timerBatched
Signature
declare const timerBatched: (ms: number, shouldYield?: Scheduler["shouldYield"]) => Scheduler
Since v2.0.0
models
Scheduler (interface)
Signature
export interface Scheduler {
shouldYield(fiber: RuntimeFiber<unknown, unknown>): number | false
scheduleTask(task: Task, priority: number): void
}
Since v2.0.0
Task (type alias)
Signature
type Task = () => void
Since v2.0.0
schedulers
defaultScheduler
Signature
declare const defaultScheduler: Scheduler
Since v2.0.0
utilities
defaultShouldYield
Signature
declare const defaultShouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false
Since v2.0.0
utils
PriorityBuckets (class)
Signature
declare class PriorityBuckets<T>
Since v2.0.0
scheduleTask (method)
Signature
declare const scheduleTask: (task: T, priority: number) => void
Since v2.0.0
buckets (property)
Signature
buckets: Array<[number, Array<T>]>
Since v2.0.0