2.1.0 • Published 2 years ago
@breejs/api v2.1.0
@breejs/api
An API for Bree.
Table of Contents
Install
npm:
npm install @breejs/apiyarn:
yarn add @breejs/apiUsage
Extend bree with the plugin:
Bree.extend(require('@breejs/api').plugin);
const bree = new Bree(config);The API will start automatically when the Bree constructor is called.
Options
| Option | Type | Description |
|---|---|---|
| port | Number | The port the API will listen on. Default: 62893 |
| jwt | Object | Configurations for JWT. Only option is secret which will be the secret used to verify JWT. |
| sse | Object | Configurations for SSE. See koa-sse for list of options. |
API
Check out the API Docs.