npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@waylay/client

v3.3.1

Published

Waylay API client for Node and the browser

Downloads

924

Readme

Waylay Client

A javascript SDK client that interfaces with the Waylay REST API's.

Installation

Installation in modern web applications

yarn add @waylay/client

or

npm install --save @waylay/client

With a script tag

You can also include the generated umd file directly into a script tag. This will add a global waylay function to the window. You can access this via window.waylay or just waylay

Include script tag

<!doctype html>

<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
</head>

<body>
  <!-- Place script tag at the end of body -->
  <!-- to get the latest version: -->
  <script src="https://unpkg.com/@waylay/client/dist/waylay.umd.js"></script>

  <!-- to get a specific version: -->
  <script src="https://unpkg.com/@waylay/[email protected]/dist/waylay.umd.js"></script>
</body>
</html>

Usage

When installed with npm

Create a client, using an apiKey and secret

const Waylay = require('@waylay/client')
const gateway = 'https://api.waylay.io'
const waylay = new Waylay({gateway})
await waylay.authenticate(myApiKey, myApiSecret)

Create a client, with a Waylay jwt token that was acquired elsewhere:

const waylay = new Waylay({gateway, token})

When included with a script tag

Create a new client, using user login (requires the tenant to be identified by its domain).

// notice the lowercase waylay
const client = new waylay({gateway, domain: 'myDomain.waylay.io'})

// login example
async function login(user, password){
  try {
    await client.login(user, password)
  } catch(err) {
    // error happened while logging in
  }
  await client.loadSettings()
}

Documentation

The API documentation for the SDK itself can be found at sdk.waylay.io. It documents how to authenticate and configure the client, and describes the services, resources and operations that are available.

The SDK client wraps the Waylay REST APIs as documented at docs.waylay.io. That documentation describes the request and response messages that you'll encounter when interacting with the SDK.