Numerous Philanthropic Misanthropes

    @zerotwobot/youtube-notification

    0.0.1 • Public • Published

    @zerotwobot/youtube-notification

    @zerotwobot/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.

    Installing

    npm install @zerotwobot/youtube-notification --save

    Example

    const YouTubeNotifier = require('@zerotwobot/youtube-notification');
    
    const notifier = new YouTubeNotifier({
      hubCallback: 'https://example.com/youtube',
      port: 27019,
      secret: 'youshallnotguessthissecret',
      path: '/youtube',
    });
    notifier.setup();
    
    notifier.on('notified', (data) => {
      console.log(
        `${data.channel.name} just uploaded a new video titled: ${data.video.title}`
      );
    });
    
    notifier.subscribe('channel_1'); // subscribe() only accepts a channel ID

    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 - the 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.

    Install

    npm i @zerotwobot/youtube-notification

    DownloadsWeekly Downloads

    9

    Version

    0.0.1

    License

    ISC

    Unpacked Size

    22.1 kB

    Total Files

    8

    Last publish

    Collaborators

    • zerotwobot