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

score-board

v1.2.4

Published

A score board for your browser. Persist state and emit events with this node module.

Downloads

3

Readme

Score Board

This module is a generic score board for your browser.

Use this module by cloning the repo

git clone [email protected]:tableflip/score-board.git

or

npm install git://github.com/tableflip/score-board.git

Don't forget to

npm install

Usage

Initiate with team names in an array:

var ScoreBoard = require('score-board')
var scoreBoard = new ScoreBoard(['sharks', 'jets'], localforage, cb)

The ScoreBoard requires a localforage or localforage like object for persisting scores.

Teams are created with a score of 0 you can increment and deduct values asynchronously which looks like this:

scoreBoard.sharks.addScore(9, cb)

This will add 9 points to the shark's score. When it's done your callback function will be executed. Callback functions follow the node callback signiture below. You don't have to pass a callback in if you don't want to.

function (err, result) {
  if (err) throw err
  doStuffWithResult(result)
}

Restoring teams and scores

If you create a ScoreBoard passing null for team names, it'll attempt to reinstate existing teams from storage:

var ScoreBoard = require('score-board')

new ScoreBoard(null, localforage, function (err, scoreBoard) {
  if (err) return console.error('No teams in storage')
  scoreBoard.getTeams(function (err, teams) {
    console.log(teams)
  })
})

API

scoreBoard.getTeams(cb) // callback with ['sharks', 'jets']

// Main score
scoreBoard.sharks.addScore(9, cb) // callback with 9
scoreBoard.sharks.getScore(cb) // callback with 9
scoreBoard.sharks.setScore(10, cb) // callback with 10
scoreBoard.sharks.deductScore(3, cb) // callback with 7

// Bonus points
scoreBoard.sharks.addBonus(9, cb) // callback with 9
scoreBoard.sharks.getBonus(cb) // callback with 9
scoreBoard.sharks.setBonus(10, cb) // callback with 10
scoreBoard.sharks.deductBonus(3, cb) // callback with 7

// Total (score + bonus)
scoreBoard.sharks.getTotal(cb) // callback with 14

Events

Team

Team objects emit the following events:

  • score:add
  • score:deduct
  • score:set
  • bonus:add
  • bonus:deduct
  • bonus:set

Uses tape in the browser for tests. To run the tests type npm test in the root of the project.


A (╯°□°)╯︵TABLEFLIP side project.