butlerd

Node.js library for butlerd, the butler daemon

Usage no npm install needed!

<script type="module">
  import butlerd from 'https://cdn.skypack.dev/butlerd';
</script>

README

butlerd for node.js

MIT licensed Build Status styled with prettier Available on npm

The butlerd package handles:

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

It implements the JSON-RPC 2.0 Specification over TCP, excluding batch requests (section 6), allowing requests and replies in both directions.

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 generous ts, see https://github.com/itchio/butler for the generous tool.

License

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