feat(cache): Add force creation option for overwriting cache

[mitsuki31]

Overview

This pull request introduces the ability to force the creation of a cache even when an entry with the same video ID already exists. This feature ensures that developers or later implementations can overwrite outdated or incorrect cache objects with new video information, keeping the cache accurate and up to date.

Changes Made

Add New Option to Force Cache Creation

• Introduced the cacheOptions.force parameter in the VInfoCache.createCache function to enable forced creation and overwriting of an existing cache with the same video ID.
• Ensures that overwriting updates the cache's properties, including the createdDate value.
• Updated the API documentation to reflect the new force option.

Add Test Case for Cache Overwrite Ability

• Added a test case to validate that the cacheOptions.force option successfully overwrites existing cache entries.
• Ensured the test verifies that the createdDate property is updated when an overwrite occurs.

Updated Implementation

createCache

class VInfoCache {
  // ...

  static function createCache(
    vInfo: ytdl.videoInfo,
    cacheOptions?: { cacheDir?: string, force?: boolean } | string
  ): Promise<string>
}

Impact

• Provides flexibility for developers to maintain accurate cache entries by forcing the creation of a cache.
• Supports potential future development scenarios that require cache entries to be refreshed or corrected programmatically.
• Prevents reliance on manual cache deletion before overwriting, streamlining workflows for developers.

Summary

This feature introduces the cacheOptions.force option to VInfoCache.createCache, allowing cache overwriting when necessary. Unit tests and API documentation updates have been included to ensure robustness and clarity.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.16%. Comparing base (ff35fa1) to head (b72300e).
Report is 3 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #98   +/-   ##
=======================================
  Coverage   83.16%   83.16%           
=======================================
  Files          12       12           
  Lines         713      713           
=======================================
  Hits          593      593           
  Misses        120      120           

Flag	Coverage Δ
Ubuntu	83.16% <100.00%> (ø)
Windows	82.88% <100.00%> (ø)
all	83.16% <100.00%> (ø)
macOS	83.16% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.