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

web-session

v0.2.2

Published

Keep user sessions between visits

Downloads

37

Readme

web-session

NPM version build status Maintainability Test Coverage

How many sessions does it take for a user to create an account or purchase something?
Now you can track these metrics!

What is a session anyway?
This is how a web session is defined by Google Analytics:

a period of time (30 minutes by default) that is extended automatically upon user interaction.

How does it end?

  • after 30 minutes of inactivity.
  • at midnight (based on your GA settings, not client timezone).
  • campaign query change (utm or gclid)

A simple demo for the react implementation of this library that you can use to inspect the session data:

Edit react-web-session demo

Usage

npm install --save web-session

And create a new session:

import WebSession from 'web-session';

const webSession = new WebSession();

// Initialize your session
webSession.init();

// After a location change or analytics event dispatched, call this function to update the session.
webSession.update();

API

type AnyObject<T = any> = Record<string, T>;
type NarrowPlainObject<T> = Exclude<T, any[] | ((...items: any[]) => any)>;

interface Options {
  /*
   * A function called on every update that receive the session data.
   * @default noop
   */
  callback: (session: Session) => void;
  /*
   * The session duration in minutes
   * @default 30
   */
  duration: number;
  /*
   * The max history size
   * @default 50
   */
  historySize: number;
  /*
   * The session name
   * @default 'WebSessionData'
   */
  name: string;
  /*
   * The session timezone used in GA
   * @default 'UTC'
   */
  timezone: string;
}

interface Origin {
  createdAt: string;
  href: string;
  referrer: string;
}

interface Session {
  current: CurrentSession;
  data?: AnyObject;
  history: Origin[];
  origin: Origin;
  visits: number;
}

constructor(options?: Partial<Options>)
Create a new instance.

init(options?: Partial<Options>)
Initialize the session. You can change the session options here.

update<T = AnyObject>(data?: T & NarrowPlainObject, replaceData = false)
Update/Replace the session data.

session
Get the current session.

Session data

({
  origin: {
    createdAt: '2000-01-01T00:15:00.000Z',
    href: '/',
    referrer: ''
  },
  current: {
    campaign: {},
    expiresAt: '2000-01-01T00:15:00.000Z',
    href: '/',
    referrer: ''
  },
  data: { // if using the optional data parameter with update
    something: true
  },
  history: [ // the different campaigns the user has entered in your site
    {
      createdAt: '2000-01-01T00:15:00.000Z',
      href: '/cpc?utm_source=cpc',
      referrer: ''
    }
  ],
  visits: 1
})

References

Counting web sessions with JavaScript by @Swizec
How a web session is defined in Analytics