YouTube Notifier

You can keep an eye on your favorite YouTube channels and get notified when a new video hits the web.
The notifier is designed with an event-driven architecture, allowing you to handle new video events, information events, and error events seamlessly.

Installation

npm install https://github.com/18Miguel/youtube-notifier

Usage

Here's an example of how to use YouTubeNotifier:

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

// Create an instance of YouTubeNotifier with a check interval of 60 seconds
const notifier = new YouTubeNotifier(60);

// Listen for new video events
notifier.on(YouTubeNotifier.NEW_VIDEO_EVENT, videoInfo => {
  console.log('New video:', videoInfo);
});

// Listen for info events
notifier.on(YouTubeNotifier.INFO_EVENT, message => {
  console.info('Info:', message);
});

// Listen for error events
notifier.on(YouTubeNotifier.ERROR_EVENT, error => {
  console.error('Error:', error);
});

// Add YouTube channel IDs to monitor
notifier.addChannels(false, 'CHANNEL_ID_1', 'CHANNEL_ID_2', 'CHANNEL_ID_3')
  .then((results) => {
    results.forEach((channelInfo) => {
      console.log(channelInfo);
    });
  })
  .catch(error => console.error(error));

// Remove YouTube channel ID after 2 seconds
setTimeout(() => {
  notifier.removeChannels('CHANNEL_ID_2')
    .then((results) => {
      results.forEach((channelInfo) => {
        console.log(channelInfo);
      });
    })
    .catch(error => console.error(error));
}, 1000 * 2);

// Get YouTube channels subscribed information
notifier.getSubscribedChannels().then((results) => {
  results.forEach((channelSubscribed) => console.log(channelSubscribed));
});

// Get YouTube channel information
notifier.getChannelInfo('CHANNEL_ID_1')
  .then(channelInfo => console.log(channelInfo));

// Stop monitoring after 10 seconds
setTimeout(() => notifier.stop(), 1000 * 10);

API

Constructor

new YouTubeNotifier(checkInterval)

Creates an instance of YouTubeNotifier.

• checkInterval (number?): The interval in seconds (minimum 50 seconds) at which to check for new videos.
• channelsIDs (...string?): The channels IDs to be added.

Methods

start()

Starts checking for new videos at the specified interval.

stop()

Stops checking for new videos.

addChannels(notify, ...channelsIDs)

Adds the specified channel IDs to the YouTubeNotifier.

• notify (boolean): Whether to notify about the latest video of the added channels.
• ...channelsIDs (string): The channel IDs to be added.
• Returns: Promise<Array<ChannelAdditionInfo>> - A promise that resolves with an array of objects representing the result of each channel addition.

ChannelAdditionInfo Object

The structure of the ChannelAdditionInfo object is as follows:

• result (ChannelAdditionResult): The result of the channel addition.
• channelID (string): The ID of the channel being added.
• video (VideoInfo): The video information of the latest video from the channel (if success is true and available).
• error (any): The error object (if success is false).
• message (string): A descriptive message about the channel addition (if success is false).

ChannelAdditionResult Enum

SUCCESS ALREADY_ADDED ERROR

removeChannels(...channelsIDs)

Removes the specified channel IDs from the YouTubeNotifier.

• ...channelsIDs (string): The channel IDs to be removed.
• Returns: Promise<Array<ChannelRemovalInfo>> - A promise that resolves with an array of objects representing the result of each channel removal.

ChannelRemovalInfo Object

The structure of the ChannelRemovalInfo object is as follows:

• success (boolean): Indicates whether the channel removal was successful.
• channelID (string): The ID of the channel being removed.

getChannelInfo(channelID)

Retrieves the information of the pretended channel.

• channelID (string): The ID of the YouTube channel.
• Returns: Promise<ChannelInfo> - A promise that resolves with channel information.

getSubscribedChannels()

Retrieves the information of the subscribed channels. The method returns a promise that resolves with an array of ChannelInfo objects, representing the subscribed channels' information. If no error occurs, each object will have the channelID, title, link and lastVideo properties. If an error occurs, the error property will contain the error message.

• Returns: Promise<Array<ChannelInfo>> - A promise that resolves with an array of channel information.

ChannelInfo Object

The structure of the ChannelInfo object is as follows:

• channelID (string): The ID of the channel.
• title (string): The title of the channel.
• link (string): The URL link to the channel.
• lastVideo (VideoInfo): The last video from the channel (if available).
• error (any): The error object if an error occurs while retrieving channel information.

Events

Events.NEW_VIDEO_EVENT

Emitted when a new video is found.

VideoInfo Object

The VideoInfo object represents information about a YouTube video. It has the following properties:

• id (string): The ID of the video.
• channelID (string): The ID of the channel that uploaded the video.
• channelName (string): The name of the channel that uploaded the video.
• title (string): The title of the video.
• link (string): The URL link to the video.
• shortLink (string): The shortened URL link to the video in the format "https://youtu.be/{id}".
• publishDate (string): The publish date of the video in the format "YYYY-MM-DD HH:MM:SS".

Events.INFO_EVENT

Emitted for informational messages.

Events.ERROR_EVENT

Emitted when an error occurs.

License

This project is licensed under the MIT License - see the LICENSE file for details.