Scheduler.ts overview

Since v2.0.0

Exports Grouped by Category

constructors

ControlledScheduler (class)

Signature

declare class ControlledScheduler

Source

Since v2.0.0

scheduleTask (method)

Signature

declare const scheduleTask: (task: Task, priority: number, fiber?: RuntimeFiber<unknown, unknown>) => void

Source

Since v2.0.0

shouldYield (method)

Signature

declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false

Source

Since v2.0.0

step (method)

Signature

declare const step: () => void

Source

Since v2.0.0

tasks (property)

Signature

tasks: PriorityBuckets<Task>

Source

Since v2.0.0

deferred (property)

Signature

deferred: boolean

Source

Since v2.0.0

MixedScheduler (class)

Signature

declare class MixedScheduler { constructor(
    /**
     * @since 2.0.0
     */
    readonly maxNextTickBeforeTimer: number
  ) }

Source

Since v2.0.0

shouldYield (method)

Signature

declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false

Source

Since v2.0.0

scheduleTask (method)

Signature

declare const scheduleTask: (task: Task, priority: number, fiber?: RuntimeFiber<unknown, unknown>) => void

Source

Since v2.0.0

SyncScheduler (class)

Signature

declare class SyncScheduler

Source

Since v2.0.0

scheduleTask (method)

Signature

declare const scheduleTask: (task: Task, priority: number, fiber?: RuntimeFiber<unknown, unknown>) => void

Source

Since v2.0.0

shouldYield (method)

Signature

declare const shouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false

Source

Since v2.0.0

flush (method)

Signature

declare const flush: () => void

Source

Since v2.0.0

tasks (property)

Signature

tasks: PriorityBuckets<Task>

Source

Since v2.0.0

deferred (property)

Signature

deferred: boolean

Source

Since v2.0.0

make

Signature

declare const make: (scheduleTask: Scheduler["scheduleTask"], shouldYield?: Scheduler["shouldYield"]) => Scheduler

Source

Since v2.0.0

makeBatched

Signature

declare const makeBatched: (
  callback: (runBatch: () => void) => void,
  shouldYield?: Scheduler["shouldYield"]
) => Scheduler

Source

Since v2.0.0

makeMatrix

Signature

declare const makeMatrix: (...record: Array<[number, Scheduler]>) => Scheduler

Source

Since v2.0.0

timer

Signature

declare const timer: (ms: number, shouldYield?: Scheduler["shouldYield"]) => Scheduler

Source

Since v2.0.0

timerBatched

Signature

declare const timerBatched: (ms: number, shouldYield?: Scheduler["shouldYield"]) => Scheduler

Source

Since v2.0.0

models

Scheduler (interface)

Signature

export interface Scheduler {
  shouldYield(fiber: RuntimeFiber<unknown, unknown>): number | false
  scheduleTask(task: Task, priority: number, fiber?: RuntimeFiber<unknown, unknown>): void
}

Source

Since v2.0.0

SchedulerRunner (class)

Signature

declare class SchedulerRunner { constructor(
    readonly scheduleDrain: (depth: number, drain: (depth: number) => void) => void
  ) }

Source

Since v3.20.0

cached (static method)

Signature

declare const cached: (
  scheduleDrain: (depth: number, drain: (depth: number) => void) => void
) => (fiber?: RuntimeFiber<unknown, unknown>) => SchedulerRunner

Source

Since v3.20.0

starve (method)

Signature

declare const starve: (depth?: number) => void

Source

scheduleTask (method)

Signature

declare const scheduleTask: (task: Task, priority: number) => void

Source

running (property)

Signature

running: boolean

Source

tasks (property)

Signature

tasks: PriorityBuckets<Task>

Source

Task (type alias)

Signature

type Task = () => void

Source

Since v2.0.0

schedulers

defaultScheduler

Signature

declare const defaultScheduler: Scheduler

Source

Since v2.0.0

utilities

defaultShouldYield

Signature

declare const defaultShouldYield: (fiber: RuntimeFiber<unknown, unknown>) => number | false

Source

Since v2.0.0

utils

PriorityBuckets (class)

Signature

declare class PriorityBuckets<T>

Source

Since v2.0.0

scheduleTask (method)

Signature

declare const scheduleTask: (task: T, priority: number) => void

Source

Since v2.0.0

buckets (property)

Signature

buckets: Array<[number, Array<T>]>

Source

Since v2.0.0