hysteria-orm 10.4.0 → 10.4.1

package/lib/index.d.cts

@@ -1078,9 +1078,32 @@ type AdminJsInstance = {
 };
 
 interface CacheAdapter {
+    /**
+     * @description Gets a value from the cache
+     * @param key The key to get the value from
+     * @returns The value from the cache
+     */
     get<T = void>(key: string): Promise<T>;
+    /**
+     * @description Sets a value in the cache
+     * @param key The key to set the value to
+     * @param data The value to set in the cache
+     * @param ttl The time to live for the value in milliseconds
+     */
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * @description Invalidates a value from the cache
+     * @param key The key to invalidate the value from
+     */
     invalidate(key: string): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAll(key: string): Promise<void>;
+    /**
+     * @description Disconnects from the cache adapter if needed when the data source disconnects
+     */
     disconnect?(): Promise<void>;
 }
 
@@ -4009,6 +4032,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     invalidCache<K extends keyof C>(key: K, ...args: Parameters<C[K]>): Promise<void>;
     invalidCache<K extends keyof C>(key: K): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAllCache(key: string): Promise<void>;
     /**
      * @description Clones the SqlDataSource instance
      * @param options.shouldRecreatePool Whether to recreate the pool of connections for the given driver, by default it's false
@@ -5299,6 +5327,7 @@ declare class InMemoryAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
 }
 
 declare class RedisCacheAdapter implements CacheAdapter {
@@ -5309,6 +5338,7 @@ declare class RedisCacheAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
     private serializeData;
     private deserializeData;
     disconnect(): Promise<void>;

package/lib/index.d.ts

@@ -1078,9 +1078,32 @@ type AdminJsInstance = {
 };
 
 interface CacheAdapter {
+    /**
+     * @description Gets a value from the cache
+     * @param key The key to get the value from
+     * @returns The value from the cache
+     */
     get<T = void>(key: string): Promise<T>;
+    /**
+     * @description Sets a value in the cache
+     * @param key The key to set the value to
+     * @param data The value to set in the cache
+     * @param ttl The time to live for the value in milliseconds
+     */
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * @description Invalidates a value from the cache
+     * @param key The key to invalidate the value from
+     */
     invalidate(key: string): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAll(key: string): Promise<void>;
+    /**
+     * @description Disconnects from the cache adapter if needed when the data source disconnects
+     */
     disconnect?(): Promise<void>;
 }
 
@@ -4009,6 +4032,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     invalidCache<K extends keyof C>(key: K, ...args: Parameters<C[K]>): Promise<void>;
     invalidCache<K extends keyof C>(key: K): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAllCache(key: string): Promise<void>;
     /**
      * @description Clones the SqlDataSource instance
      * @param options.shouldRecreatePool Whether to recreate the pool of connections for the given driver, by default it's false
@@ -5299,6 +5327,7 @@ declare class InMemoryAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
 }
 
 declare class RedisCacheAdapter implements CacheAdapter {
@@ -5309,6 +5338,7 @@ declare class RedisCacheAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
     private serializeData;
     private deserializeData;
     disconnect(): Promise<void>;