Socket
Socket
Sign inDemoInstall

@breejs/api

Package Overview
Dependencies
515
Maintainers
5
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @breejs/api

An API for Bree.


Version published
Weekly downloads
11
decreased by-89.42%
Maintainers
5
Created
Weekly downloads
 

Readme

Source

@breejs/api

build status code coverage code style styled with prettier made with lad

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

OptionTypeDescription
portNumberThe port the API will listen on. Default: 62893
jwtObjectConfigurations for JWT. Only option is secret which will be the secret used to verify JWT.
sseObjectConfigurations for SSE. See koa-sse for list of options.

API

Check out the API Docs.

Contributors

License

MIT © Nick Baugh

Keywords

FAQs

Last updated on 02 Aug 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc