Skip to content
This repository was archived by the owner on Feb 3, 2023. It is now read-only.

User's Guide 03:00 Configuration

Ed Ropple edited this page May 22, 2018 · 1 revision

TaskBotJS's server configuration is provided through a Config<TDependencies extends IDependencies> object. (If you're not using TypeScript, don't worry--the generic declaration exists just to make life easier for TypeScript users, you'll be fine!) This Config object allows you to control TaskBotJS programmatically, meaning that we aren't onerous about how you get configuration data into TaskBotJS. You can hardcode values if appropriate for your project, you can fetch them from a file or from environment variables, whatever--the only requirement is that the configuration file you pass to the taskbot executable script returns as either module.exports or module.exports.default an object of type Config.

This configuration object does a few different things.

  • It defines the data source that TaskBotJS uses.
  • It defines the total number of jobs that TaskBotJS will allow to be launched, per-process, at any given time.

You can see an example configuration in the /example project.

Clone this wiki locally