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

division818

v1.1.0

Published

A youtube wrapper for https://pubsubhubbub.appspot.com/

Downloads

10

Readme

youtube-notification

youtube-notification is a basic wrapper for Pubsubhubbub. It allows you to receive YouTube notifications when a channel uploads or modifies a video with a simple subscribe and unsubscribe system.

Install

npm install youtube-notification

Example

const YouTubeNotifier = require('youtube-notification');

const notifier = new YouTubeNotifier({
  hubCallback: 'https://example.com/youtube',
  port: 8080,
  secret: 'Something',
  path: '/youtube'
});
notifier.setup();

notifier.on('notified', data => {
  console.log('New Video');
  console.log(
    `${data.channel.name} just uploaded a new video titled: ${data.video.title}`
  );
});

notifier.subscribe('channel_1');

Events

  • 'subscribe' - A channel has been verified to begin receiving notifications.
  • 'unsubscribe' - A channel has been verified to stop receiving notifications.
  • 'notified'(data) - A channel has uploaded/modified/deleted a video.
    • data is an object which contains the following properties: video, channel, published and updated.

API

YouTubeNotifier.constructor(options)

options is an object that you may write your own properties to. The following properties are read by YouTubeNotifier:

  • secret - A private key used by Pubsubhubbub, it is not required to include this property but it is highly recommended that you do. Defaults to undefined
  • hubCallback - Your ip/domain name that will be used as a callback URL by Pubsubhubbub. It must be in a URL format, ex: 'https://example.com/'. This is a required property as the default is undefined.
  • middleware - If you are going to use the notifier with a middle ware. Defaults to false.
  • path - The path on which the server will interact with the hub. Defaults to '/'. Not required if you are using the notifier with a middleware.
  • port - The port Pubsubhubbub will listen on. This must be an open port on your system. Defaults to port 3000. Not required if you are using the notifier with a middleware.
  • hubUrl - The URL in which we listen to updates from. This shouldn't be changed unless you know what you're doing.

YouTubeWatch.setup()

This function will setup a server to interact with Pubsubhubbub. If this function is called after the server has already been setup an error is thrown. If this is used with middleware set to true, an error is thrown.

YouTubeWatch.listener()

This functions will creates and return an Express middleware handler for PubSubHubbub.

YouTubeWatch.subscribe(channels=[])

Subscribes to a channel or a list of channels IDs. Channels may either be a string or an array of strings. After each successful channel has been verified to receive updates a subscribe event is ommited.

YouTubeWatch.unsubscribe(channels=[])

Removes the watch state from a list of channel IDs. Channels may either be a string or an array of strings. After each successful channel has been verified to stop receiving updates an unsubscribe event is ommited.