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

suppressionlist

v0.1.2

Published

SuppressionList API client

Downloads

371

Readme

SuppressionList API Client

This is a Node.js module for calling the SuppressionList API.

Build Status

Client

To use SuppressionList, require this module and create a new Client instance using your API key.

const Client = require('suppressionlist-api-client');

const apiKey = '123456';

const client = new Client(apiKey);

// now you can use the client
client.getLists((err, lists) => {
  if (err) throw err;
  console.log(lists);
});

Client Functions

All functions take a callback that is invoked with two parameters:

  • err — the error, if one occured, or null if one did not
  • results — the results of the call. For calls that return multiple records, this is an Array. When fetching a single record, this is a plain old Object, as returned by the SuppressionList API.
getLists(callback)

The getLists() function returns all the lists in your account. There is not currently a way to filter. SuppressionList will always return all lists.

createList(name, ttl, callback)

The createList() function creates a new list in your account. The name is the human-readable name for the list. The ttl is the "time to live" for records in that list, in seconds.

ensureList(name, ttl, callback)

The ensureList() function ensures that a list with the given name exists. If it does, it'll be returned without modification. If it does not, then it'll be created and returned.