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

bloody-snowplow-tracker

v3.2.0

Published

## Install

Downloads

10

Readme

Snowplow tracker

Install

$ npm install --save bloody-snowplow-tracker

Import

import { createTracker } from "bloody-snowplow-tracker"

API

createTracker(config): tracker

config

  • config.appName: string, your app's name
  • config.trackerName: string, the tracker's name
  • config.networkLayer: networkLayer, the network layer object

Creates a new tracker.

defaultNetworkLayer(url: string)

The default network layer relies on loading a pixel. In order for this to work, the url you provide to the default network layer must be an image.

import

In order for custom configurations not to bring an extra network layer, you have to require defaultNetworkLayer alone:

import { defaultNetworkLayer } from "bloody-snowplow-tracker/lib/NetworkLayer"

url

The URL of the collector.

tracker.trackPageView(?config): Promise

config

If not provided, these parameters are set automatically.

  • config.pageURL: string
  • config.pageTitle: string
  • config.pageReferrer: string
  • config.middleware: ?function

tracker.trackStructuredEvent(config): Promise

config

  • config.structuredEventCategory: string
  • config.structuredEventAction: string
  • config.structuredEventLabel: string
  • config.structuredEventProperty: string
  • config.structuredEventValue: string

tracker.trackSocialAction(config): Promise

config

  • config.socialAction: string
  • config.socialNetwork: string
  • config.socialTarget: string
  • config.socialPagePath: string

compose(...functions): function

In order to use multiple middlewares, you can use the compose utility provided by the tracker:

import { createTracker } from "bloody-snowplow-tracker"
import { compose } from "bloody-snowplow-tracker/lib/compose"

const postfixFingerprint = (event) => {
  return {
    ...event,
    fingerprint: event.fingerpring.then((item) => item + cookie.get("foo"))
  }
}

const postfixAppName = (event) => {
  return {
    ...event,
    appName: event.appName + ".ok"
  }
}

const tracker = createTracker({
  appName: "foo",
  trackerName: "bar",
  // … networkLayer
  middleware: compose(
    postfixFingerprint,
    postfixAppName
  ),
})

Implementing your own networkLayer

Your networkLayer must contain a send method, taking a single event object argument, and return a promise reflecting the state of the request.

If you want to transform human-readable events to the snowplow format, you can use the transformEvent module.

import { transformEvent } from "bloody-snowplow-tracker/lib/transformEvent"

const myCustomNetworkLayer = {
  send: (event) => {
    return fetch("/collector", {
      method: "POST",
      body: JSON.stringify(transformEvent(event)),
    })
      .then((res) => {
        if(res.status !== 200) {
          throw new Error()
        }
      })
  },
}