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

promo-server

v1.0.6

Published

Useful promo management for ITW Creative Works.

Downloads

23

Readme

📦 Install Promo Server

Option 1: Install via npm

Install with npm if you plan to use Promo Server in a Node.js project or in the browser.

npm install promo-server

If you plan to use promo-server in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.

const promoserver = new (require('promo-server'))();

Option 2: Install via CDN

Install with CDN if you plan to use Promo Server only in a browser environment.

<script src="https://cdn.jsdelivr.net/npm/promo-server@latest/dist/index.min.js"></script>
<script type="text/javascript">
  var promoserver = new PromoServer(); // The script above exposes the global variable 'PromoServer'
</script>

🦄 Features

  • Useful promo management for ITW Creative Works

📘 Example Setup

After installing via npm, simply require the library and begin enjoying the promo handler.

const promoserver = new (require('promo-server'))({
  app: 'example', // <any string>
  platform: 'web', // web | electron | extension
  log: true, // true | false
  firebase: firebase // reference to firebase (one will be implied if not provided)
});

⚡️ Usage

promoserver.handle(fn)

Set up a handler for new promo updates that will call fn when there is a promo update

promoserver.handle(function (payload) {
  console.log('Payload', payload);
});

promoserver.setUser(user)

Set the current user so things like user.plan.id can be considered for the handler

promoserver.setUser({});

🗨️ Final Words

If you are still having difficulty, we would love for you to post a question to the Promo Server issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

Ask us to have your project listed! :)