Platform 6 Node.js Connector

Platform 6 Node.js connector

This repository is a Platform 6 connector 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 connector depends on:

• Node.js (version >= 4),
• Platform 6 (version 5.17.0 and higher)

Installing the connector

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

$ npm install --save @platform6/platform6-connector

Using the connector

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