🐦 Node.js client for butlerd, the butler daemon
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
.babelrc
.gitignore
.release-it.json
.travis.yml
LICENSE
README.md
browser.js
electron-main.js
index.js
package-lock.json
package.json
tsconfig.json

README.md

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.