@waylay/client

Waylay API client for Node and the browser

Usage no npm install needed!

<script type="module">
  import waylayClient from 'https://cdn.skypack.dev/@waylay/client';
</script>

README

Waylay Client

Build Status

Node.js client to interface with the Waylay API's

Installation

yarn add @waylay/client

or

npm install --save @waylay/client

Usage

Create a new client:

const Waylay = require('@waylay/client')

const client = new Waylay({
  clientID: 'CLIENT_ID',
  secret: 'CLIENT_SECRET',
  domain: 'my-domain.waylay.io'
})

Documentation

Run the documentation server locally. Edit the documentation.yml file to adapt the table of content for the navigation side bar.

yarn documentation serve lib/waylay.js --config documentation.yml --watch
open http://localhost:4001

Browser

To use this in the browser

yarn build

To create an UMD minified bundle file in dist/waylay.umd.js

Test

yarn test

Release

npm version <major/minor/patch>
git push
git push --tags
npm publish --access=public

API

See documentation