Summary of Changes

Hello @jaredwray, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a comprehensive migration guide to assist users in upgrading from Keyv v5 to v6. The guide meticulously outlines the breaking changes, new features, and necessary adjustments to ensure a smooth transition. It covers significant architectural shifts, API changes, and the introduction of new capabilities, all aimed at improving the library's robustness and flexibility. The documentation provides clear instructions and code examples to help developers adapt their existing implementations to the new version.

Highlights

• Namespace Overhaul: The useKeyPrefix and keyPrefix properties have been removed, with namespace handling now fully managed by the storage adapters themselves.
• Removed opts Property: The opts property has been eliminated; all Keyv configuration properties are now directly accessible on the Keyv instance.
• Serialization Adapter: The stringify and parse options are replaced by a new serialization property that accepts a dedicated serialization adapter.
• Hookified Integration: Keyv now uses the standard Hookified library for events and hooks, introducing new hook function calls and naming conventions.
• Updated Return Types: deleteMany now returns boolean[] (indicating success for each deletion), and setMany uses KeyvEntry[] for input while also returning boolean[].
• Dedicated Raw Data Access: Raw data access has been removed from get and getMany; dedicated getRaw and getManyRaw methods are now used for this purpose.
• Iterator Simplification: The iterator no longer requires an argument, and an isIterable() function has been added to check for iteration support.
• TTL Support Handling: The ttlSupport property has been removed from storage adapters, with Keyv automatically detecting and handling TTL via KeyvGenericStore for non-native TTL stores.
• Consistent undefined Returns: Keyv now consistently returns undefined instead of null for missing values, normalizing behavior across adapters.
• New Features Introduced: New features include command timeout at the Keyv level, @keyv/bigmap as the default in-memory store, browser compatibility, new serialization and encryption adapters, and identification functions (isKeyv, getStoreCapabilities, isKeyvAdapter).

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (0e971c3) to head (201eb27).

@@            Coverage Diff            @@
##              main     #1833   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           32        32           
  Lines         2434      2434           
  Branches       446       446           
=========================================
  Hits          2434      2434           

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