4Cron
/
Plugin-Tools
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A package/library that exports a variety of utility functions that simplify building plugins and scripts for [Cronicle](https://cronicle.net)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 Commits
1 Branch
13 Tags
118 KiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
4lch4 7a1f2917b9
chore: deleted pnpm-lock 		2 months ago
.vscode chore: executed prettier 6 months ago
data chore: added some more sample data 6 months ago
src feat: created a Strings file to contain message strings 6 months ago
.drone.template.yml chore(.drone.template.yml): formatting change 6 months ago
.drone.yml refactor(.drone.yml): updated repoOwner for Drone manifest 6 months ago
.gitignore feat: initial commit of working code 12 months ago
.npmignore chore: executed prettier 6 months ago
.npmrc chore: added .npmrc file 6 months ago
.nvmrc chore: added .nvmrc and pnpm-lock.yaml 6 months ago
.prettierignore feat: initial commit of working code 12 months ago
.prettierrc chore: executed prettier 6 months ago
Makefile feat: added base of Makefile 6 months ago
README.md chore: executed prettier 6 months ago
package.json feat: added fs-extra dependency for IOUtil class 6 months ago
tsconfig.json chore: executed prettier 6 months ago

README.md

Drone Build Status NPM License NPM Version Monthly Downloads (NPM) Snyk Vulnerabilities for npm package

code style: prettier Discord Twitter-Profile

Cronicle Plugin Tools

This project is to provide some helper functions to a new NodeJS module that wishes to be a Cronicle Plugin.

Exported Members

The following list defines/describes the members that are exported by the @4is-cronicle/plugin-tools package:

  • @4lch4/logger
    • All exported members of the @4lch4/logger library are also exported by @4is-cronicle/plugin-tools.
  • Interfaces
  • Top-Level Functions
    • initJob
      • Initialize a Cronicle job. Returns the job input object read from STDIN.
      • Returns an object of type IJobInput.
    • endJob
      • Ends the execution of the job by writing the output to STDOUT using JSON.stringify() and then exiting the process using the code provided in output.code. The exit code defaults to 0 unless otherwise specified.
      • Requires a parameter object of type IJobOutput.
  • Utility Class(es)
    • IOUtil
      • Provides the readPipedInput method for reading input from STDIN and parsing it as a JSON object.