@financial-times/n-worker

Setup of basic next enhancements for non-web dynos e.g. cron-jobs, pollers

Stats

StarsIssuesVersionUpdatedCreatedSize
@financial-times/n-worker
013.1.03 years ago6 years agoMinified + gzip package size for @financial-times/n-worker in KB

Readme

n-worker

Setup of basic next enhancements for non-web dynos e.g. cron-jobs, pollers

API

n-worker#setup(options)

Sets up node enhamcemets

  • fetch as a global using isomorphic-fetch
  • metrics for processes and fetch
  • flags (optional)

options:

  • withFlags default false - waits for the flags client to initialise and start polling
  • name optional - will get the app name from package.json if absent
  • directory defaults to process.cwd() directory in which to look for config code

Returns a Promise.

Usage: javascript worker.setup(options).then(function(){ //Application init code })

n-worker#CronJob(options)

Constructor for a new cron job, with metrics etc. added. options expects the same as npm cron.CronJob

n-worker#metrics

Reference to the instance of metrics used by the job

n-worker#flags

Reference to the instance of flags used by the job

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.