urbit-client v1.1.2-rc

urbit-client-js

JavaScript client library for urb-it integration

Installation

npm i --save urbit-client@1.1.2-rc

Usage

ES5

  /**
   * UrbitClient constructor
   *
   * @param {String} storeKey The store key (store ID/GUID).
   * @param {String} sharedSecret The shared secret (consumer secret).
   * @param {boolean} [stage=false] Whether the staging environment should be used instead of production.
   *
   * @throws \Error
   */

const UrbitClient = require('urbit-client').UrbitClient;
const client = new UrbitClient(...);

Only UWA:

const UWA = require('urbit-client').UWA;
const uwa = new UWA(...);

ES6

import UrbitClient from 'urbit-client';

  /**
   * UrbitClient constructor
   *
   * @param {String} storeKey The store key (store ID/GUID).
   * @param {String} sharedSecret The shared secret (consumer secret).
   * @param {boolean} [stage=false] Whether the staging environment should be used instead of production.
   *
   * @throws \Error
   */
const urbitClient = new UrbitClient(...);

Only UWA:

import { UWA } from 'urbit-client';

  /**
   * UWA constructor
   *
   * @param {String} storeKey
   * @param {String} sharedSecret
   * @param {String} [method=GET]
   * @param {String} uri
   * @param {String} json
   */
const uwa = new UWA(...);

Both:

import { UrbitClient, UWA } from 'urbit-client';

const urbitClient = new UrbitClient(...);
const uwa = new UWA(...);

Documentation

For mor documentation, see the wiki.

Maintainers & Contributors

• Sebastian Mandrean sebastian@urb-it.com (Maintainer)
• Johan Strandberg johan@urb-it.com (Contributor)