Skip to content

ermproject/commerce.js

Repository files navigation

commerce.js

CircleCI Codecov Version Downloads/week License

Easy to use JavaScript SDK for managing carts and selling products from your chec.io store.

https://commercejs.com

Installation

With NPM

npm install @chec/commerce.js

Documentation

See the documentation webpage.

Upgrading

The major change in Commerce.js v2 is that most methods now return a promise that is fulfilled when the HTTP request is completed. Instead of providing callbacks to the methods in this module, you will have to use promise syntax instead.

- Commerce.Cart.retrieve(function (data) {
+ Commerce.cart.retrieve().then(function (data) { 
  // ...
});

Additionally, the API for the various features are now lower-cased.

The cart.add() method now separates its arguments:

- Commerce.Cart.add({ productId: 1, quantity: 2, variant: { foo: 'bar'} })
+ Commerce.cart.add(1, 2, {foo: 'bar'})

Contributing

Running the tests

You can run the unit tests for this library from your command line using npm run test, or npm run test:watch to watch for changed and re-run the tests automatically.

Code style

We use the Airbnb JavaScript style guide, and Prettier as our linting tool. To lint your code, use npm run lint or npm run lint:fix to automatically fix violations.

Packages

No packages published

Languages

  • JavaScript 100.0%