liqid-node

The Liqid Node library provides convenient access to the Liqid REST API from applications written in server-side JavaScript.

Installation

The Liqid Node library can be installed via NPM or Yarn.

Using NPM

npm install liqid --save

Using Yarn

yarn add liqid

Usage

The package needs to be configured with your Liqid switch's IP address and base API path:

const liqid = require('liqid')('https://12.34.56.78/liqid/api/v2/');

liqid.groups
     .create({
       fabr_id: 81,
       group_name: 'Test Group',
       grp_id: 3,
       pod_id: -1
     })
     .catch(function(error) {
       console.error(error);
     })
     .then(function(response) {
       console.log(response);
     });

Contributing

Please read through the contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

For personal support requests, please use Discussions to get help.

Versioning

For transparency into the release cycle and in striving to maintain backward compatibility, the Liqid Node library is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but I'll adhere to those rules whenever possible.

See the Releases section of the GitHub project for changelogs for each release version of the Liqid Node library.

Support

The issue tracker is the preferred channel for bug reports, feature requests and submitting pull requests.

Copyright and License

Code and documentation copyright Liqid Inc. Code released under the MIT license.