@cxco/api-dcx

DigitalCX api client

Stats

StarsIssuesVersionUpdatedCreatedSize
@cxco/api-dcx
3.4.010 months ago3 years agoMinified + gzip package size for @cxco/api-dcx in KB

Readme

CXCO API DCX

Simple DigitalCX API wrapper. Listens to core.on events and emits response to core

Getting Started

Install the module with: npm install @cxco/api-dcx or place into your package.json and run npm install.

Prerequisites

This project requires you to have the necessary credentials to use DCX It's used as a plugin in CXCO-core.

import CxcoCore from '@cxco/core'
import cxcoDcxApi from '@cxco/api-dcx'

const instance = new CxcoCore({ useWindowConfig: true })
instance.use(cxcoDcxApi(options))

Running the tests

run npm run test. Uses Jest for the unit tests.

Break down into end to end tests

Explain what these tests test and why

Give an example

Deployment

Babelify and bundle

Built With

  • Axios - for handling http requests

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.