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

amplitude-client-node

v1.1.0

Published

Simple, no-dependency wrapper around Amplitude's HTTP API

Downloads

204

Readme

amplitude-client-node

Build Status

A simple wrapper around Amplitude's Groups and HTTP (v2) APIs.

For legacy v1 HTTP API, use v0.2.0.

Features:

  • automatic, configurable retry with generated insert_id
  • TypeScript support
  • No dependencies
  • event tracking (/2/httpapi)
  • group identification (/groupidentify)
  • user identification (/identify)
  • there are tests
  • requires Node v8 or higher

Installation

npm install amplitude-client-node

Usage

const amplitude = require('amplitude-client-node');
// for typescript:
// import * as amplitude from 'amplitude-client-node';

const client = new amplitude.AmplitudeClient('api key', {
    // all keys are optional
    maxRetries: 3,
    timeoutMs: 2500,
    enabled: true, // disable sending of events, useful in dev
    endpoint: 'https://api.amplitude.com',
    appVersion: '1.2.3', // will set app_version in all outgoing events
    setTime: true, // will set time to Date.now() in all outgoing events
    logging: (level, message) => {
        console.log(`${level}: ${message}`);
    }
});

const myEvent = {
    event_type: 'user register',
    user_id: '12345',
    event_properties: {
        source: 'marketing site',
        whatever: 'you want',
    },
    groups: {
        teamId: '67890'
    }
};

client.track(myEvent)
    .then((result) => {
        console.log(`successfully sent event to amplitude: ${result.body.toString('utf8')}`);
    })
    .catch((err) => {
        console.error(`amplitude api call failed after ${err.response.retryCount} retries: ${err.message}`);
    });

Successful calls return an AmplitudeResponse object:

interface AmplitudeResponse<T> {
    statusCode: number;
    body: Buffer;
    start: Date;
    end: Date;
    requestOptions: https.RequestOptions;
    responseHeaders: http.IncomingHttpHeaders;
    succeeded: boolean;
    retryCount: number;
    requestData: T;
}

If all retries fail, or a non-retryable status code is returned from the Amplitude API, then an error object is thrown that has a response property that is set to the AmplitudeResponse object defined above.