Skip to content
This repository has been archived by the owner on Jul 3, 2019. It is now read-only.
/ n-worker Public archive

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

Notifications You must be signed in to change notification settings

Financial-Times/n-worker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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