Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ScheduleOps

Index

Functions

pluginOptions

  • pluginOptions(schedule: Schedule): Promise<{ description: string; key: string; options: Array<{ description?: string; examples?: Array<any>; key: string }>; required: boolean; type: string }[]>
  • Load the options for this schedule from the plugin

    Parameters

    Returns Promise<{ description: string; key: string; options: Array<{ description?: string; examples?: Array<any>; key: string }>; required: boolean; type: string }[]>

run

  • run(schedule: Schedule, run: Run): Promise<{ highWaterMark: HighWaterMark; importsCount: number; sourceOffset: string | number }>
  • Parameters

    Returns Promise<{ highWaterMark: HighWaterMark; importsCount: number; sourceOffset: string | number }>

runPercentComplete

  • runPercentComplete(schedule: Schedule, run: Run): Promise<number>
  • Determine the percentage complete for this run

    Parameters

    Returns Promise<number>

Generated using TypeDoc