customer-js-sdk

1.73.2 • Public • Published

customer-js-sdk

The customer-js-sdk is a Front-End layer of abstraction for communicating with Back-End services.

Install

npm install --save customer-js-sdk

Import

import { v0 as sdk } from 'customer-js-sdk';

BaseUrl

  • Setting the baseUrl
sdk.baseUrl.set('http://custom.api/');

Headers

  • Setting a header
sdk.headers.append('Content-Type', 'application/json');
  • Retrieving all headers
sdk.headers.get();
  • Removing a header
sdk.headers.remove('Content-Type');

Usage Examples

  • GET request without parameters
sdk.merchants.partners.get();
  • GET request with URL parameter
sdk.merchants.addresses.get({
  urlParam: '123456789'
});
  • POST request with body
sdk.merchants.contacts.post({}, {
  body: '123456789'
});
  • POST request with URL parameter and body
sdk.merchants.contacts.post({
  urlParam: '123456789'
}, {
  body: '123456789'
});
  • Passing a custom baseUrl to overide the default in a specific request
sdk.merchants.partners.get('https://custom.api/');
 
sdk.merchants.addresses.get('https://custom.api/', {
  urlParam: '123456789'
});
 
sdk.merchants.contacts.post('https://custom.api/', {
  urlParam: '123456789'
}, {
  body: '123456789'
});

Using Middlewares

Middlewares run before and after every request in the same order that they were declared. Every middleware must call either proceed or quit in order to work.

sdk.middleware.use({
  beforeRequest({ proceed, quit }) {
    if (conditionMet) {
      proceed();
    } else {
      quit();
    }
  },
  afterRequest({ proceed }) {
    logSomething();
    proceed();
  }
});
 
sdk.middleware.use({
  async beforeRequest({ proceed }) {
    await doSomethingAsync();
    proceed();
  }
});

See more information on our Wiki page.

Readme

Keywords

none

Package Sidebar

Install

npm i customer-js-sdk

Weekly Downloads

192

Version

1.73.2

License

Apache-2.0

Unpacked Size

1.03 MB

Total Files

1137

Last publish

Collaborators

  • sling-web