An API for Bree.
npm install @breejs/api
> An API for [Bree][].
[npm][]:
``sh`
npm install @breejs/api
[yarn][]:
`sh`
yarn add @breejs/api
Extend bree with the plugin:
`js
Bree.extend(require('@breejs/api').plugin);
const bree = new Bree(config);
`
The API will start automatically when the Bree constructor is called.
| Option | Type | Description |
| :------: | :------: | ---------------------------------------------------------------------------------------------- |
| port | Number | The port the API will listen on. Default: 62893 |secret` which will be the secret used to verify JWT. |
| jwt | Object | Configurations for JWT. Only option is
| sse | Object | Configurations for SSE. See [koa-sse][] for list of options. |
Check out the API Docs.
##
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/
[Bree]: https://jobscheduler.net/#/
[koa-sse]: https://github.com/yklykl530/koa-sse