@wpazderski/js-utils
    Preparing search index...

    Abstract base class for scheduling callbacks.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _isFrozen: boolean = false

    Indicates whether the scheduler is frozen.

    allowSchedulingWhenScheduled: boolean = false

    Indicates whether the scheduler allows scheduling (scheduleCore() call) when it is already scheduled. This can be overridden in subclasses to change the default behavior.

    The callback function to be executed by the scheduler.

    shouldBeScheduledOnUnfreeze: boolean = false

    Indicates whether the scheduler should be scheduled on unfreeze.

    Accessors

    Methods

    • Freezes the scheduler, preventing it from executing the callback. If the scheduler is currently scheduled, it will be canceled and then rescheduled on unfreeze(). If the scheduler is already frozen, this method does nothing.

      Returns void

    • Schedules the callback to be executed. If the scheduler is already scheduled, it does nothing. If the scheduler is frozen, it will be scheduled on unfreeze().

      Returns void

    • Unfreezes the scheduler, allowing it to execute the callback again. If the scheduler was frozen with a scheduled callback, it will be rescheduled. If schedule() was called while frozen, it will be scheduled now. If the scheduler is not frozen, this method does nothing.

      Returns void

    • Schedules a callback to be executed once. This method is static and should be overridden by subclasses to provide specific scheduling behavior.

      Parameters

      • _callback: SchedulerCallback

        The callback to be executed.

      • Optional_options: unknown

        Optional parameters for scheduling.

      Returns void

      NotImplementedError If not implemented in the subclass.