@amalto/platform6-client

Platform 6 Node.js client

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@amalto/platform6-client
Minified + gzip package size for @amalto/platform6-client in KB

Readme

Platform 6 Node.js Client

Platform 6 Node.js client

Build Status Coverage Status

This repository is a Platform 6 client aiming to help the development a service in JavaScript. It exposes, among others, methods to facilitate the communication with a Platform 6 instance.

Requirements

Platform 6 client depends on:

Installing the client

The following command installs Platform 6 client as a Node.js dependency:

$ npm install --save @amalto/platform6-client

Using the client

Demo project

You can find an example of a service using this library here.

Logging

We rely on the library debug for debugging.

To display the logs of Platform 6, set the DEBUG environment variable like this:

$ DEBUG=platform6:* node index.js

To filter the logs, please refer to the documentation of debug.

API

You will find the documentation of the methods exposed in the section API.

Release notes

Please refer to changelog to see the descriptions of each release.

License

MIT © Platform 6

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.