cacheable 2.1.0 → 2.2.0

package/dist/index.d.cts

@@ -1,7 +1,5 @@
-import { WrapFunctionOptions, GetOrSetKey, GetOrSetFunctionOptions } from '@cacheable/memoize';
-export { GetOrSetFunctionOptions, GetOrSetKey, GetOrSetOptions, WrapOptions, WrapSyncOptions, getOrSet, wrap, wrapSync } from '@cacheable/memoize';
-import { Stats, CacheableItem, HashAlgorithm } from '@cacheable/utils';
-export { CacheableItem, Stats as CacheableStats, HashAlgorithm, calculateTtlFromExpiration, getCascadingTtl, hash, shorthandToMilliseconds, shorthandToTime } from '@cacheable/utils';
+import { Stats, CacheableItem, WrapFunctionOptions, GetOrSetKey, GetOrSetFunctionOptions, HashAlgorithm } from '@cacheable/utils';
+export { CacheableItem, Stats as CacheableStats, GetOrSetFunctionOptions, GetOrSetKey, GetOrSetOptions, HashAlgorithm, WrapOptions, WrapSyncOptions, calculateTtlFromExpiration, getCascadingTtl, getOrSet, hash, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync } from '@cacheable/utils';
 import { Hookified, HookifiedOptions } from 'hookified';
 import { Keyv, KeyvStoreAdapter, StoredDataRaw } from 'keyv';
 export { Keyv, KeyvHooks, KeyvOptions, KeyvStoreAdapter } from 'keyv';
@@ -408,14 +406,24 @@ declare class Cacheable extends Hookified {
      */
     getOrSet<T>(key: GetOrSetKey, function_: () => Promise<T>, options?: GetOrSetFunctionOptions): Promise<T | undefined>;
     /**
-     * Will hash an object using the specified algorithm. The default algorithm is 'sha256'.
+     * Will hash an object asynchronously using the specified cryptographic algorithm.
+     * Use this for cryptographic algorithms (SHA-256, SHA-384, SHA-512).
+     * For non-cryptographic algorithms, use hashSync() for better performance.
      * @param {any} object the object to hash
-     * @param {string} algorithm the hash algorithm to use. The default is 'sha256'
+     * @param {string} algorithm the hash algorithm to use. The default is 'SHA-256'
+     * @returns {Promise<string>} the hash of the object
+     */
+    hash(object: any, algorithm?: HashAlgorithm): Promise<string>;
+    /**
+     * Will hash an object synchronously using the specified non-cryptographic algorithm.
+     * Use this for non-cryptographic algorithms (DJB2, FNV1, MURMER, CRC32).
+     * For cryptographic algorithms, use hash() instead.
+     * @param {any} object the object to hash
+     * @param {string} algorithm the hash algorithm to use. The default is 'djb2'
      * @returns {string} the hash of the object
      */
-    hash(object: any, algorithm?: HashAlgorithm): string;
+    hashSync(object: any, algorithm?: HashAlgorithm): string;
     private setManyKeyv;
-    private hasManyKeyv;
     /**
      * Processes a single key from secondary store for getRaw operation
      * @param primary - the primary store to use

package/dist/index.d.ts

@@ -1,7 +1,5 @@
-import { WrapFunctionOptions, GetOrSetKey, GetOrSetFunctionOptions } from '@cacheable/memoize';
-export { GetOrSetFunctionOptions, GetOrSetKey, GetOrSetOptions, WrapOptions, WrapSyncOptions, getOrSet, wrap, wrapSync } from '@cacheable/memoize';
-import { Stats, CacheableItem, HashAlgorithm } from '@cacheable/utils';
-export { CacheableItem, Stats as CacheableStats, HashAlgorithm, calculateTtlFromExpiration, getCascadingTtl, hash, shorthandToMilliseconds, shorthandToTime } from '@cacheable/utils';
+import { Stats, CacheableItem, WrapFunctionOptions, GetOrSetKey, GetOrSetFunctionOptions, HashAlgorithm } from '@cacheable/utils';
+export { CacheableItem, Stats as CacheableStats, GetOrSetFunctionOptions, GetOrSetKey, GetOrSetOptions, HashAlgorithm, WrapOptions, WrapSyncOptions, calculateTtlFromExpiration, getCascadingTtl, getOrSet, hash, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync } from '@cacheable/utils';
 import { Hookified, HookifiedOptions } from 'hookified';
 import { Keyv, KeyvStoreAdapter, StoredDataRaw } from 'keyv';
 export { Keyv, KeyvHooks, KeyvOptions, KeyvStoreAdapter } from 'keyv';
@@ -408,14 +406,24 @@ declare class Cacheable extends Hookified {
      */
     getOrSet<T>(key: GetOrSetKey, function_: () => Promise<T>, options?: GetOrSetFunctionOptions): Promise<T | undefined>;
     /**
-     * Will hash an object using the specified algorithm. The default algorithm is 'sha256'.
+     * Will hash an object asynchronously using the specified cryptographic algorithm.
+     * Use this for cryptographic algorithms (SHA-256, SHA-384, SHA-512).
+     * For non-cryptographic algorithms, use hashSync() for better performance.
      * @param {any} object the object to hash
-     * @param {string} algorithm the hash algorithm to use. The default is 'sha256'
+     * @param {string} algorithm the hash algorithm to use. The default is 'SHA-256'
+     * @returns {Promise<string>} the hash of the object
+     */
+    hash(object: any, algorithm?: HashAlgorithm): Promise<string>;
+    /**
+     * Will hash an object synchronously using the specified non-cryptographic algorithm.
+     * Use this for non-cryptographic algorithms (DJB2, FNV1, MURMER, CRC32).
+     * For cryptographic algorithms, use hash() instead.
+     * @param {any} object the object to hash
+     * @param {string} algorithm the hash algorithm to use. The default is 'djb2'
      * @returns {string} the hash of the object
      */
-    hash(object: any, algorithm?: HashAlgorithm): string;
+    hashSync(object: any, algorithm?: HashAlgorithm): string;
     private setManyKeyv;
-    private hasManyKeyv;
     /**
      * Processes a single key from secondary store for getRaw operation
      * @param primary - the primary store to use