supergood
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

description: The Node.js client is written in Typescript and is non-blocking.

Node.js

The Supergood Node.js client connects Supergood to your Node.js application. Follow these steps to integrate with the Node.js client.

1. Install the Supergood library

# with yarn
yarn add supergood@latest
# with npm
npm install supergood@latest

2. Initialize the Supergood library

Environment variables

Set the environment variables SUPERGOOD_CLIENT_ID and SUPERGOOD_CLIENT_SECRET using the API keys generated in the getting started instructions.

Initialize the Supergood client at the root of your application, or anywhere you're making API calls with the following code:

// with ES Modules
import Supergood from 'supergood'

Supergood.init()
// with CommonJS
const Supergood = require('supergood')

Supergood.init()

Passing keys

You can also pass the API keys in manually without setting environment variables.

Replace <CLIENT_ID> and <CLIENT_SECRET> with the API keys you generated in the getting started instructions.

// with ES Modules
import Supergood from 'supergood'

Supergood.init({ clientId: <CLIENT_ID>, clientSecret: <CLIENT_SECRET> })
// with CommonJS
const Supergood = require('supergood')

Supergood.init({ clientId: <CLIENT_ID>, clientSecret: <CLIENT_SECRET> })

3. Monitor your API calls

You're all set to use Supergood!

Head back to your dashboard to start monitoring your API calls and receiving reports.

Links

Readme

Keywords

none

Package Sidebar

Install

npm i supergood

Weekly Downloads

121

Version

2.1.0

License

ISC

Unpacked Size

179 kB

Total Files

85

Last publish

Collaborators

  • aklarfeld