Module: cache

This module provides caching functionalities for YouTube video information.

It includes classes and methods to encode, decode, compress, and decompress video information, as well as to create, check, and retrieve cached data.

Since:
  • 2.0.0
Author:
  • Ryuu Mitsuki <https://github.com/mitsuki31>
License:
  • MIT
Source:
Example
const { VInfoCache } = require('./cache');

async function cacheVideoInfo(videoInfo) {
  try {
    const cachePath = await VInfoCache.createCache(videoInfo);
    console.log(`Cache created at: ${cachePath}`);
  } catch (error) {
    console.error('Error creating cache:', error);
  }
  return cachePath;
}

async function getCachedVideoInfo(videoId) {
  try {
    const cachedInfo = await VInfoCache.getCache(videoId);
    if (cachedInfo) {
      console.log('Cached video info:', cachedInfo);
    } else {
      console.log('No cache found for video ID:', videoId);
    }
  } catch (error) {
    console.error('Error retrieving cache:', error);
  }
  return cachedInfo;
}

// Example usage
const videoInfo = ytdl.getInfo('https://www.youtube.com/watch?v=abc123');
const cachePath = await cacheVideoInfo(videoInfo);
const cache = await getCachedVideoInfo('abc123');
console.log(cachePath);
console.log(cache);

Requires

Classes

CacheBase64
CacheZLib
VInfoCache

Members

(package, inner, constant) CACHE_EXPIRE_TIME :number

Expiration time for cache entries in milliseconds (2 hours).

Type:
  • number
Since:
  • 2.0.0
Source:

Methods

(package, inner) getCachePath(id) → {string}

Generates the cache path for a given video ID.

The cache path is generated by joining the cache directory path with the provided video ID.

Parameters:
Name Type Description
id string

The unique identifier for the cache entry.
Since:
  • 2.0.0
Source:
See:
Returns:

The absolute path to the cache file.

Type
string

(async, package, inner) hasExpired(cache, expireTimeopt, debugopt) → {Promise.<Boolean>}

Checks whether a given cache entry has expired, with an optional check for connectivity and content availability.

It will attempt to check the content availability by sending a HEAD request using fetch and then check for its response if and only if the device is connected to the internet. Furthermore, the function will check whether the cache date creation has passed 2 hours since created. If the content is available and the cache has passed 2 hours, the function will returns true due to cache is still accessible and valid. Or if the cache is not available after fetched, but the cache has not passed 2 hours yet, the function will returns false instead due to cache is no longer accessible.

Parameters:
Name Type Attributes Default Description
cache VideoInfoCacheObject | ExtractedVideoInfoCacheObject

The cache object.
expireTime number <optional>
 CACHE_EXPIRE_TIME

The expiration time in milliseconds. Defaults to CACHE_EXPIRE_TIME.
debug boolean <optional>
 false

Whether to output all debug information while checking cache expiration time.
Since:
  • 2.0.0
Source:
Throws:

If the provided cache object is malformed.

Type
InvalidTypeError
Returns:

Fulfills with Boolean object evaluated to true if the cache has expired, otherwise false.

Type
Promise.<Boolean>