Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.72 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.72 KB
Raw

canduit

Build status bitHound Score bitHound Dependencies bitHound Dev Dependencies

Node.js Phabricator Conduit API client.

Getting Started

var createCanduit = require('canduit');

// Create and authenticate client
createCanduit(function (err, canduit) {

  // Execute a conduit API call
  canduit.exec('user.query', {
    usernames: ['aleksey']
  }, function (err, users) {

    console.log(users);
  });
});

Documentation

Canduit(config, callback)

The Canduit constructor takes an optional config parameter, and a callback(error, conduit) function. The callback fires after the canduit client instance has successfully authenticated with the server.

The first argument of the callback function is an error (if present), and the second is the reference to the conduit client instance for convenience.

The config object can take the following configuration parameters:

  • configFile - file to read the Arcanist configuration parameters. By default, canduit reads ~/.arcrc for host and authentication configuration.

You can also programmatically override the Conduit host and credentials:

  • user - conduit username,
  • api - conduit api root,
  • cert - conduit certificate
  • token - token obtined via arc install-certificate

canduit.exec(route, params, callback)

Call a conduit API endpoint.

  • route is the name of the endpoint, and
  • params object contains the parameters to pass.
  • callback(error, result) a callback function that fires when the conduit server responds.

In case of client, server, or conduit-specific errors, the error parameter holds the Error instance, and the result is falsy. If the call suceeds, the result is set to an object containing response data.

canduit.authenticate(callback)

Re-authenticate the client with the server. Called internally by the constructor, but exposed in case you encounter an authentication timeout.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via npm lint and test via npm test.

License

Copyright (c) 2014 Uber

Licensed under the MIT license.