https://github.com/breejs/api

An API for Bree.
https://github.com/breejs/api

Last synced: about 1 year ago
JSON representation

An API for Bree.

• Host: GitHub
• URL: https://github.com/breejs/api
• Owner: breejs
• License: other
• Created: 2021-08-20T21:12:20.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-28T04:30:41.000Z (over 1 year ago)
• Last Synced: 2025-04-14T15:21:30.077Z (about 1 year ago)
• Language: JavaScript
• Size: 5.21 MB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# @breejs/api

[![build status](https://github.com/breejs/ts-worker/actions/workflows/ci.yml/badge.svg)](https://github.com/breejs/ts-worker/actions/workflows/ci.yml)

[![code coverage](https://img.shields.io/codecov/c/github/breejs/api.svg)](https://codecov.io/gh/breejs/api)

[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![made with lad](https://img.shields.io/badge/made_with-lad-95CC28.svg)](https://lad.js.org)

> An API for [Bree][].

## Table of Contents

## Install

[npm][]:

```sh

npm install @breejs/api

```

[yarn][]:

```sh

yarn add @breejs/api

```

## Usage

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.

## 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](https://documenter.getpostman.com/view/17142435/TzzDLbNG).

## Contributors

## License

[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)

##

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/

[Bree]: https://jobscheduler.net/#/

[koa-sse]: https://github.com/yklykl530/koa-sse