@mx51/spi-client-js

JavaScript Client Library for mx51's In-Store Integration.

Usage no npm install needed!

<script type="module">
  import mx51SpiClientJs from 'https://cdn.skypack.dev/@mx51/spi-client-js';
</script>

README

SPI Client JavaScript NPM Build Status Code Coverage

This is the JavaScript client library for mx51 in-store integration.

Setup

Below are basic instructions on how to run the library for development. If all you want to do is use the library in your project, just import @mx51/spi-client-js from npm.

Building

To download the dependencies and install the package, run the following:

npm install

Testing

To run a suite of unit tests configured in karma.conf.js, run the following:

npm test

Creating a distribution

To create a distribution, run the following:

npm run transpile

This will update the dist/spi-client.js.js file used for the npm package.

Disclaimer

This source code is provided “as is” or “as available” and mx51 makes no representations or warranties, express or implied, regarding the source code, that the source code will meet your requirements, or that this source code will be error-free. mx51 expressly disclaims any and all express and implied warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. Without limiting the generality of the foregoing, mx51 does not warrant, endorse, guarantee, or assume responsibility for this source code.

In no event shall mx51 be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this source code, even if advised of the possibility of such damage.