node-busedeprecated

Node.js library for the butler API

Usage no npm install needed!

<script type="module">
  import nodeBuse from 'https://cdn.skypack.dev/node-buse';
</script>

README

node-buse

MIT licensed Build Status styled with prettier

node-buse handles:

  • launching butler in service mode
  • connecting to it
  • sending requests and notifications to it
  • receiving results and notifications from it
  • terminating it

It implements bidirectional the JSON-RPC 2.0 Specification over TCP, excluding batch requests (section 6)

It also ships with typings for all methods of the buse (butler service) JSON-RPC 2.0 service, allowing one to make requests and notifications in a type-safe way, as long as it stays in sync with buse's own types.

Usage

It would be neat to have a code sample right in the README, but those tend to get out-of-sync with the actual code

Instead, please head over to the tests - they ought to be readable!

Note that this repository does not include any request or notification definitions. These can be generated with busegen ts, see https://github.com/itchio/butler for the busegen tool.

License

node-buse is released under the MIT license, see the LICENSE file.