Skip to content

@lands.io/mod-sdk / SchedulerJobContext

Interface: SchedulerJobContext

Context provided to scheduler jobs during execution.

Table of contents

Properties

Properties

modId

modId: string

The mod's unique identifier


storage

storage: IModStorage

Persistent storage for the mod


trigger

Optional trigger: "scheduled" | "manual"

Execution trigger. - "scheduled": normal cron-driven execution - "manual": ad-hoc execution requested by an operator


Source Code

View full implementation
/**
 * Context provided to scheduler jobs during execution.
 */
export interface SchedulerJobContext {
  /** Persistent storage for the mod */
  storage: IModStorage;
  /** The mod's unique identifier */
  modId: string;
  /**
   * Execution trigger.
   * - "scheduled": normal cron-driven execution
   * - "manual": ad-hoc execution requested by an operator
   */
  trigger?: 'scheduled' | 'manual';
}