Skip to main content

Interface: PluginScheduleConfig

Defined in: src/plugins/core/import-scheduler.ts:29

Configuration for scheduling a plugin's import cycles.

Properties​

intervalMs​

readonly intervalMs: number

Defined in: src/plugins/core/import-scheduler.ts:50

Interval between import cycles in milliseconds.

Remarks​

Recommended intervals:

  • 12 hours (43200000ms) for sources with infrequent updates
  • 6 hours (21600000ms) for sources with moderate updates
  • 1 hour (3600000ms) for high-frequency sources

Consider the source's rate limits and update frequency. Minimum value: 60000ms (1 minute).

plugin​

readonly plugin: ImportingPlugin

Defined in: src/plugins/core/import-scheduler.ts:36

The importing plugin instance to schedule.

Remarks​

Must implement the ImportingPlugin abstract class with fetchEprints().

runOnStart?​

readonly optional runOnStart: boolean

Defined in: src/plugins/core/import-scheduler.ts:61

Whether to run an import cycle immediately on schedule registration.

Remarks​

Set to true for system startup to populate initial data. Set to false if data was recently imported.

Default Value​

false

timeoutMs?​

readonly optional timeoutMs: number

Defined in: src/plugins/core/import-scheduler.ts:72

Maximum duration for an import cycle before timeout.

Remarks​

If an import cycle exceeds this duration, it will be marked as failed but not forcibly terminated. The next scheduled cycle will run on time.

Default Value​

3600000 (1 hour)