JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
__mocks__
__tests__
docs
example
src
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package.json
rollup.config.js
yarn.lock

README.md

bpost

JavaScript API wrapper for bpost track & trace

NPM David Travis StackShare Gitmoji

Installation

Install via yarn

yarn add bpost (--dev)

or npm

npm install bpost (--save-dev)

If you don't use a package manager, you can access bpost via unpkg (CDN), download the source, or point your package manager to the url.

bpost is compiled as a collection of CommonJS modules & ES2015 modules for bundlers that support the jsnext:main or module field in package.json (Rollup, Webpack 2)

The bpost package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a <script> tag on your page. The UMD builds make bpost available as a window.bpost global variable.1

This module was created using the magnificent generator-module-boilerplate.

Usage

Take a look at the documentation to get an in-depth use case scenario and more guidelines.

Examples

see the examples folder. A working example is available on cloud9.

Contributing

We are open to contributions, see CONTRIBUTING.md for more info.

License

The code is available under the MIT license.

1: UMD builds are currently broken due to changes needed in either Rollup or Axios. There is an issue for this here.