1.6.0 • Published 1 month ago
@websolutespa/payload-plugin-cron-job v1.6.0
@websolutespa/payload-plugin-cron-job
Cron job plugin for PayloadCms.
Payload Cron job Plugin
A plugin for Payload CMS that adds collections and UI components to manage cron jobs with activity logs.
Requirements:
- Payload CMS version 1.2.1 or higher is required.
Installation
npm i @websolutespa/payload-plugin-cron-job
Usage
import { buildConfig } from 'payload/config';
import { clearLogs, cronJob } from '@websolutespa/payload-plugin-cron-job';
export default buildConfig({
plugins: [
cronJob({
jobs: {
alwaysOn: {
execute: (payload: Payload) => {
console.log('ScheduledTask.alwaysOn every 5 minutes');
},
cron: '*/5 * * * *',
},
clearLogs: {
execute: async (payload: Payload) => {
console.log('ScheduledTask.clearLogs every sunday at 01:00');
return await clearLogs(payload);
},
cron: '0 1 * * 0',
},
},
}),
]
});
Plugin options
property | description |
---|---|
jobs | an object containing methods to run scheduled, each method is an object with an execute handler and a cron unix-cron string format |