Heroic Lands

Interface Schedulable

The minimal document surface the schedule mutators need.

interface Schedulable {
    logic?: SohlLogic<any>;
    system: { scheduledActions?: ScheduledAction[] };
    uuid: string;
    update(data: Record<string, unknown>): Promise<unknown>;
}

Properties

logic? system uuid

Methods

update

Properties

Optionallogic

logic?: SohlLogic<any>

The document's Logic — parents an event-driven schedule's ScheduledAction.predicate (issue #569). Every SoHL document exposes it; only an event schedule with a predicate reads it.

system

system: { scheduledActions?: ScheduledAction[] }

The document's system data (carries scheduledActions).

uuid

uuid: string

The document's uuid.

Methods

update

  • update(data: Record<string, unknown>): Promise<unknown>

  • Persist a partial update to the document.

    Parameters

    • data: Record<string, unknown>

    Returns Promise<unknown>

Settings

Member Visibility

On This Page

Properties
Methods