#CronJobManager

CronJobManager — це менеджер запланованих завдань, що надається NocoBase та базується на cron. Він дозволяє плагінам реєструвати заплановані завдання на сервері для періодичного виконання певної логіки.

#Основне використання

import { Plugin } from '@nocobase/server';

export default class PluginCronDemo extends Plugin {
  async load() {
    this.app.cronJobManager.addJob({
      cronTime: '0 0 * * *', // Виконується щодня о 00:00
      onTick: async () => {
        console.log('Щоденне завдання: очищення тимчасових даних');
        await this.cleanTemporaryData();
      },
      timeZone: 'Asia/Shanghai',
      start: true, // Автоматичний запуск
    });
  }

  async cleanTemporaryData() {
    // Тут виконується логіка очищення
  }
}

#Опис параметрів

Визначення типу CronJobParameters виглядає так (з cron):

export declare interface CronJobParameters {
  cronTime: string | Date | DateTime;
  onTick: CronCommand;
  onComplete?: CronCommand | null;
  start?: boolean;
  timeZone?: string;
  context?: any;
  runOnInit?: boolean;
  utcOffset?: string | number;
  unrefTimeout?: boolean;
}

| Параметр | Тип | Опис
| cronTime | string \| Date \| DateTime | Вираз часу для запланованого завдання. Підтримує стандартні cron-вирази, наприклад, 0 0 * * * означає виконання щодня о 00:00. CronJobManager — це менеджер запланованих завдань, що надається NocoBase та базується на cron. Він дозволяє плагінам реєструвати заплановані завдання на сервері для періодичного виконання певної логіки.

#Основне використання

import { Plugin } from '@nocobase/server';

export default class PluginCronDemo extends Plugin {
  async load() {
    this.app.cronJobManager.addJob({
      cronTime: '0 0 * * *', // Виконується щодня о 00:00
      onTick: async () => {
        console.log('Щоденне завдання: очищення тимчасових даних');
        await this.cleanTemporaryData();
      },
      timeZone: 'Asia/Shanghai',
      start: true, // Автоматичний запуск
    });
  }

  async cleanTemporaryData() {
    // Тут виконується логіка очищення
  }
}

#Опис параметрів

Визначення типу CronJobParameters виглядає так (з cron):

export declare interface CronJobParameters {
  cronTime: string | Date | DateTime;
  onTick: CronCommand;
  onComplete?: CronCommand | null;
  start?: boolean;
  timeZone?: string;
  context?: any;
  runOnInit?: boolean;
  utcOffset?: string | number;
  unrefTimeout?: boolean;
}

| Параметр | Тип | Опис CronJobManager — це менеджер запланованих завдань, що надається NocoBase та базується на cron. Він дозволяє плагінам реєструвати заплановані завдання на сервері для періодичного виконання певної логіки.

#Основне використання

import { Plugin } from '@nocobase/server';

export default class PluginCronDemo extends Plugin {
  async load() {
    this.app.cronJobManager.addJob({
      cronTime: '0 0 * * *', // Виконується щодня о 00:00
      onTick: async () => {
        console.log('Щоденне завдання: очищення тимчасових даних');
        await this.cleanTemporaryData();
      },
      timeZone: 'Asia/Shanghai',
      start: true, // Автоматичний запуск
    });
  }

  async cleanTemporaryData() {
    // Тут виконується логіка очищення
  }
}

#Опис параметрів

Визначення типу CronJobParameters виглядає так (з cron):

export declare interface CronJobParameters {
  cronTime: string | Date | DateTime;
  onTick: CronCommand;
  onComplete?: CronCommand | null;
  start?: boolean;
  timeZone?: string;
  context?: any;
  runOnInit?: boolean;
  utcOffset?: string | number;
  unrefTimeout?: boolean;
}

| Параметр | Тип | Опис CronJobManager — це менеджер запланованих завдань, що надається NocoBase та базується на cron. Він дозволяє плагінам реєструвати заплановані завдання на сервері для періодичного виконання певної логіки.

#Основне використання

import { Plugin } from '@nocobase/server';

export default class PluginCronDemo extends Plugin {
  async load() {
    this.app.cronJobManager.addJob({
      cronTime: '0 0 * * *', // Виконується щодня о 00:00
      onTick: async () => {
        console.log('Щоденне завдання: очищення тимчасових даних');
        await this.cleanTemporaryData();
      },
      timeZone: 'Asia/Shanghai',
      start: true, // Автоматичний запуск
    });
  }

  async cleanTemporaryData() {
    // Тут виконується логіка очищення
  }
}

#Опис параметрів

Визначення типу CronJobParameters виглядає так (з cron):

export declare interface CronJobParameters {
  cronTime: string | Date | DateTime;
  onTick: CronCommand;
  onComplete?: CronCommand | null;
  start?: boolean;
  timeZone?: string;
  context?: any;
  runOnInit?: boolean;
  utcOffset?: string | number;
  unrefTimeout?: boolean;
}

| Параметр | Тип | Опис
| onComplete | function | Виконується, коли завдання зупиняється за допомогою job.stop() або після завершення функції onTick.
| timeZone | string | Вказує часовий пояс виконання (наприклад, Asia/Shanghai). CronJobManager — це менеджер запланованих завдань, що надається NocoBase та базується на cron. Він дозволяє плагінам реєструвати заплановані завдання на сервері для періодичного виконання певної логіки.

#Основне використання

import { Plugin } from '@nocobase/server';

export default class PluginCronDemo extends Plugin {
  async load() {
    this.app.cronJobManager.addJob({
      cronTime: '0 0 * * *', // Виконується щодня о 00:00
      onTick: async () => {
        console.log('Щоденне завдання: очищення тимчасових даних');
        await this.cleanTemporaryData();
      },
      timeZone: 'Asia/Shanghai',
      start: true, // Автоматичний запуск
    });
  }

  async cleanTemporaryData() {
    // Тут виконується логіка очищення
  }
}

#Опис параметрів

Визначення типу CronJobParameters виглядає так (з cron):

export declare interface CronJobParameters {
  cronTime: string | Date | DateTime;
  onTick: CronCommand;
  onComplete?: CronCommand | null;
  start?: boolean;
  timeZone?: string;
  context?: any;
  runOnInit?: boolean;
  utcOffset?: string | number;
  unrefTimeout?: boolean;
}

| Параметр | Тип | Опис
| context | any | Контекст, в якому виконується onTick.