simplejob

A tool class to wrap your jobs/scripts and easily get logs and reports like 👇

[12:11:49] 🚀 Job started...
[12:11:49] Error on user [42]
[12:11:49] Error while fetching date
[12:11:49] ✅ Job done.
+------------------- Job report ---------------------+
👷 Job >  testJob
📁 Path > /Users/alex/Documents/perso/simplelogs-package/src/testJob.ts
🚦 Status >  warning
⏰ Duration >  0.004s
💬 Args >
        - startDate: "2021-10-10"
        - endDate: "2023-10-10"
📊 Results >
        - notificationSent: 42
🚩 Errors >
        - Error on user [42]
        - Error while fetching date
+------------------------------------------------------+

Installaton

yarn add simplejob
# or
npm i -S simplejob

import { SimpleJob, JobStatus } from "simplejob";

class MyJob extends SimpleJob {
  connect = async () => {
    // your database connection
  };

  disconnect = async () => {
    // your database connection
  };

  onEnd = async (status: JobStatus, crashError?: any) => {
    // your custom actions
  };
}

Usage

Create your job

const job = new MyJob({
  maintainer: "John Doe",
  filename: __filename,
});

job.start(async () => {
  // Your job operations...
});

Adding results/errors/logs

job.addResult("userMigrated"); // Adding 1 result.
job.addResult("userMigrated", 42); // Adding 42 results.

job.addError(`Error on user ${user.id}`, { userId: user.id }); // Adding an error with data.

job.addLog(`${user.id} migrated`);

Getting args

getArgs helps you getting args params, logging errors and usage using Joi.

const args = job.getArgs<{
  country: "france" | "usa";
  city?: string;
  confirm?: boolean;
}>(
  {
    country: Joi.string().valid("usa").valid("france").required(),
    city: Joi.string(),
  },
  {
    confirm: Joi.boolean(),
  }
);

will log

> node myjob germany orleans
"country" is invalid
Usage: "node myjob <country> [city] [--confirm]"

💡 Note: for now, compatible Joi package is "17.4.0"

Exporting csv

await job.exportCsv(`${__dirname}/data/user_data.csv`, [
  { id: 1, name: "John" },
  { id: 2, name: "Jane" },
]);

Will write a csv file using writeStream (create path if it doesn't exist).

Incoming...

This package doc and Class is still in construction, some features are coming in next versions! fork children, getArgs without Joi, exportJson, saveReport, customizations...

API

🚧 In construction...

SimpleJob Class api

SimpleJob constructor options

Options used with constructor call 👉 const job = new SimpleJob(options)