@fimwise-trigger/schedule
v1.0.0
Published
`@fimwise-trigger/schedule` is a Node.js module that provides a schedule trigger for the Fimwise Bot platform. It allows you to schedule tasks using cron expressions.
Downloads
5
Readme
@fimwise-trigger/schedule
@fimwise-trigger/schedule
is a Node.js module that provides a schedule trigger for the Fimwise Bot platform.
It allows you to schedule tasks using cron expressions.
Usage
Define trigger in process configuration
To use this trigger, you need to define it in the process configuration file.
The trigger name should be @fimwise-trigger/schedule
.
{
"name": "sample-process",
"triggers": [
{
"name": "@fimwise-trigger/schedule"
}
]
}
Install the package
To install the package, run:
fimwise-bot install path/to/process.json
This command will also install all the dependencies required by the process which also includes the
@fimwise-trigger/schedule
package.
Configuration
This trigger supports the following configuration options:
cron
: The cron expression to schedule the task. This is required.once
: A boolean indicating if the task should run only once. Default isfalse
.input
: Any input data that should be passed to the task when it is triggered.
Example
{
"name": "sample-process",
"triggers": [
{
"name": "@fimwise-trigger/schedule",
"cron": "0 0 1 * *",
"once": true,
"input": {
"message": "Hello, World!"
}
}
]
}
License
This project is licensed under the MIT License.