# simplejob > A tool class to wrap your jobs/scripts and easily get logs and reports like ๐Ÿ‘‡ Latest version **0.3.5** (published 2023-01-30) ยท MIT license ยท 0 weekly downloads ## Install ```sh npm install simplejob pnpm add simplejob yarn add simplejob bun add simplejob ``` ## Health **Score 25/100 (F)** โ€” status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.3.5 | | Published | 2023-01-30 | | First published | 2023-01-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 54.6 KB | | Known vulnerabilities | 0 (+4 in 2 direct dependencies) | | Install scripts | no | | GitHub stars | 1 | | Author | alcaroff | | Maintainers | monpetitgazon, shellstrom | | Keywords | job, script, args, logs, report, cron, task | ## Links - npm: https://www.npmjs.com/package/simplejob - Repository: https://github.com/alcaroff/simplejob - npm.io page: https://npm.io/package/simplejob ## Dependencies (7) - [joi](https://npm.io/package/joi.md) 17.4.0 - [uuid](https://npm.io/package/uuid.md) ^9.0.0 - [axios](https://npm.io/package/axios.md) ^1.2.6 - [dayjs](https://npm.io/package/dayjs.md) ^1.11.7 - [colors](https://npm.io/package/colors.md) ^1.4.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [minimist](https://npm.io/package/minimist.md) ^1.2.6 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) โ€” 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) โ€” 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) โ€” 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) โ€” 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) โ€” 155.6K weekly downloads ## Recent versions - 0.3.5 (latest) โ€” 2023-01-30 - 0.3.4 โ€” 2023-01-30 - 0.3.3 โ€” 2023-01-30 - 0.3.2 โ€” 2023-01-30 - 0.3.1 โ€” 2023-01-30 - 0.3.0 โ€” 2023-01-29 - 0.2.1 โ€” 2023-01-28 - 0.2.0 โ€” 2023-01-28 - 0.1.12 โ€” 2023-01-24 - 0.1.11 โ€” 2023-01-22 - 0.1.10 โ€” 2023-01-21 - 0.1.9 โ€” 2023-01-20 - 0.1.8 โ€” 2023-01-20 - 0.1.7 โ€” 2023-01-19 - 0.1.5 โ€” 2023-01-15 - โ€ฆ 4 more at https://npm.io/package/simplejob/versions ## README # 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 ```sh yarn add simplejob # or npm i -S simplejob ``` ```ts 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 ```ts const job = new MyJob({ maintainer: "John Doe", filename: __filename, }); job.start(async () => { // Your job operations... }); ``` ### Adding results/errors/logs ```ts 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. ```ts 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 ```sh > node myjob germany orleans "country" is invalid Usage: "node myjob [city] [--confirm]" ``` > ๐Ÿ’ก Note: for now, compatible Joi package is "17.4.0" ### Exporting csv ```ts 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 | property | description | type | default | | ------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ---------------------- | | connect | Connect function called before job execution | `async () => void` | | | disconnect | Disconnect function called after the job execution | `async () => void` | | | onEnd | Function called after the job execution | `async (status: JobStatus, crashError?: any) => void` | | | start | Start | `async (async () => any) => void` | | | status | Actual status of the job instance | `'pending'` | `'running'` | `'warning'` | `'success'` | `'error'` | `'exit'` | `'pending'` | | timeformat | Format of time to be displayed in logs | [dayjs format](https://day.js.org/docs/en/display/format) | `'hh:mm:ss'` | | env | Environment of the job | `string` | `undefined` | `process.env.NODE_ENV` | | getArgs | Get args and return an object of it | `(params, namedParams) => object` | `function` | | exportCsv | Export csv data in a file (create dir) | `(path, data) => void` | `function` | | addError | Add an error | `(message: string, data: any) => void` | `function` | | addLog | Add a log | `(message: string, data: any) => void` | `function` | | args | Arguments object filled with `.getArgs` | `object` | `{}` | | logs | Logs filled with `.addError` and `.addLog` | `JobLog[]` | `[]` | | results | Results filled with `.addResult` | `JobResult[] ` | `[]` | | reportErrorsLimit | Limit of errors to be displayed in the report | `number` | `6` | | disableReport | Disable the report at the end of the job | `boolean` | `false` | | disableConnect | Disable the connect/disconnect methods at the start/end of the job | `boolean` | `false` | | maintainer | Name of the maintainer | `string` | `undefined` | | | scriptName | Name of the file (deducted from constructor option `filename`) | `string` | | | scriptPath | Full path (equal from constructor option `filename`) | `string` | | | description | Description of the job | `string` | | | maintainer | name of the author/maintainer | `string` | | | startedAt | Date of the start of the job | `Date` | | | endedAt | Date of the end of the job | `Date` | | | startedAtTimestamp | Timestamp of the start of the job | `number` | | | endedAtTimestamp | Timestamp of the end of the job | `number` | | | simplelogsToken | Token to be used to send logs to simplelogs (incoming) | `string` | `undefined` | | | tags | Tags to be used to send logs to simplelogs (incoming) | `string[]` | `undefined` | | | thread | Thread for simplelogs app (incoming) | `string` | | ### SimpleJob constructor options Options used with constructor call ๐Ÿ‘‰ `const job = new SimpleJob(options)` | property | description | type | required | | -------- | ------------------------------------ | -------- | -------- | | filename | Full path of the file (`__filename`) | `string` | [x] | ``` ``` --- _Source: https://npm.io/package/simplejob ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._