@breejs/api

An API for Bree.

Table of Contents

Install

npm:

npm install @breejs/api

yarn:

yarn add @breejs/api

Usage

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.

Contributors

License

MIT © Nick Baugh