This repository provides a JavaScript library to make requests against a JMAP server. It is a client-side implementation of the JMAP specification. It is developed using ES6 and transpiled to ES5 code using babel.js.
Non-exhaustive list of features:
- Entities are modeled as JavaScript classes.
- Expose a Client class that you can use to send JMAP requests, using a fluent API.
- Uses Promises exclusively, and allows for pluggable Promise implementation.
- Allows for pluggable transports, with default support for node.js request and jQuery in the browser.
The library is provided as a NPM or Bower packages, thus to install either use:
npm install jmap-client
or
bower install jmap-client
depending on your preferred package manager.
git clone https://ci.open-paas.org/stash/scm/olibs/jmap-client.git
cd jmap-client
npm install
grunt
More detailled instructions can be found in the contributing section.
If you are a maintainer of this project, here's how you can release a new version:
- Checkout the master branch and pull the latest changes from the remote repository
- Run
grunt releaseto do the release. A lot of things will happen but you'll eventually be back on the master branch - Bump the version in master to NEXT_VERSION-dev (replace NEXT_VERSION by the supposed next version)