1.0.0 • Published 13 days ago

@lanternfly/imogen v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
13 days ago

Imogen

npm version

Imogen is a Node based job scheduler build on top of Node Schedule.

Getting Started

  1. Install the package @lanternfly/imogen globally using npm install -g @lanternfly/imogen.
  2. Create a configuration file. See the Configuration section for more details.
  3. Run imogen validate --config=<path to config file> to validate the configuration file. See below for more information on configuration files.
  4. Run imogen run --config=<path to config file> to run the job scheduler.

Configuration

Sample Configuration File

{
  "jobs": [
    {
      "name": "job-1",
      "time": "* * * * * *",
      "command": "ls"
    }
  ]
}

Configuration API

A configuration is a json file with the following fields:

FieldTypeDescriptionIs Required?Default
jobsYes
jobs[#].nameStringThe name of the job. The name can only contain letters, numbers, dashes, and underscores.No
jobs[#].timeStringYes
jobs[#].commandStringYes
jobs[#].overlapBooleanFlag for whether multiple instances of job can be executed at once. If true, multiple instances can run concurrently. If false, the next job will not be run until the previous instance has been completed.NoTrue
pino.optionsObjectThe options passed to pino when creating a logger. See Pino documentation for more details.No{}
pino.destinationString / ObjectThe destination passed to pino when creating a logger. See Pino documentation for more details.No{}

Officially Supported Node Versions

  • 18.x
  • 20.x
  • 21.x
1.0.0

13 days ago

0.7.0

13 days ago

0.6.2

1 month ago

0.6.1

1 month ago

0.6.0

1 month ago

0.5.4

2 months ago

0.5.3

3 months ago

0.5.2

3 months ago

0.5.1

4 months ago

0.5.0

4 months ago

0.4.1

4 months ago

0.4.0

4 months ago

0.3.0

4 months ago

0.2.0

4 months ago

0.1.2

4 months ago

0.1.1

6 months ago

0.1.0

6 months ago