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

@safelytyped/well-watched

v0.2.0

Published

A safe type for working with dynamic watch lists.

Downloads

9

Readme

Welcome To @safelytyped/well-watched!

Introduction

Well-Watched is a safe type for working with dynamic watch lists.

It's inspired by the way Vuex registers and manages its list of subscribers.

Quick Start

# run this from your Terminal
npm install @safelytyped/well-watched
// add this import to your Typescript code
import { WatchList } from "@safelytyped/well-watched"

// WatchList is a generic type. If you call it with an empty list of topics
// and watchers, you need to tell the compiler what type each watcher is.
const myWatchList = new WatchList<string>({});

// add the string "watcher1" to a set of topics
//
// the return value is a function you can use to remove "watcher1"
// from all of these topics at any point in the future
const unsubWatcher1 = myWatchList.add("watcher1", "topic1", "topic2", "topic3");

myWatchList.forEach((watcher: string, topic: string) => {
    // this will be called for every watcher
    // that is registered for the topics you ask for
    //
    // in our case, it'll get called:
    //
    // ["watcher1", "topic1"]
    // ["watcher1", "topic3"]
}, "topic1", "topic3");

// if you're no longer interested, you can remove "watcher1" from
// the list of topics
unsubWatcher1();

VS Code users: once you've added a single import anywhere in your project, you'll then be able to auto-import anything else that this library exports.

Our Unit Tests

Our unit tests also serve as documentation.

  MODULE_NAME
    ✓ has the value '@safelytyped/well-watched/lib/v1'

  isWatchList()
    accepts valid WatchListData
      ✓ accepts example {"_topicsAndWatchers":{}}
    rejects invalid WatchListData
      ✓ rejects example null
      ✓ rejects example undefined
      ✓ rejects example []
      ✓ rejects example true
      ✓ rejects example false
      ✓ rejects example 3.1415927
      ✓ rejects example 0
      ✓ rejects example -100
      ✓ rejects example 100
      ✓ rejects example {}
      ✓ rejects example "hello world"

  makeWatchList()
    ✓ returns a WatchList
    ✓ applies default functional options
    ✓ does not apply default functional options when extra functional options passed in

  mustBeWatchList()
    accepts valid WatchList
      ✓ accepts example {"_topicsAndWatchers":{}}
    rejects valid WatchList
      ✓ rejects example null
      ✓ rejects example undefined
      ✓ rejects example []
      ✓ rejects example true
      ✓ rejects example false
      ✓ rejects example 3.1415927
      ✓ rejects example 0
      ✓ rejects example -100
      ✓ rejects example 100
      ✓ rejects example {}
      ✓ rejects example "hello world"

  validateWatchList()
    accepts valid WatchListData
      ✓ accepts example {"_topicsAndWatchers":{}}
    rejects invalid WatchListData
      ✓ rejects example null
      ✓ rejects example undefined
      ✓ rejects example []
      ✓ rejects example true
      ✓ rejects example false
      ✓ rejects example 3.1415927
      ✓ rejects example 0
      ✓ rejects example -100
      ✓ rejects example 100
      ✓ rejects example {}
      ✓ rejects example "hello world"

  WatchList
    .constructor()
      ✓ accepts an empty list
      ✓ accepts an initial list of topics
    .add()
      ✓ adds a watcher to the given list of topics
      ✓ returns a function which will unsubscribe the watcher from all the topics
      ✓ the returned unsubscribe function is a no-op when called a second time
    .forEach()
      ✓ applies your callback to every watcher in the given list of topics
      ✓ ignores topics that have no watchers
    .length
      ✓ returns 0 when there are no watchers registered
      ✓ returns the number of watchers across all topics


  49 passing (20ms)

Documentation

Looking for more detailed documentation? You'll find it under the docs folder.