polystore 0.18.0 → 0.20.0

package/index.d.ts

@@ -1,4 +1,9 @@
+type Prefix = string;
 type Expires = number | null | string;
+type Options = {
+    prefix?: Prefix;
+    expires?: Expires;
+};
 type StoreData<T extends Serializable = Serializable> = {
     value: T;
     expires: number | null;
@@ -8,7 +13,7 @@ type Serializable = string | number | boolean | null | (Serializable | null)[] |
 };
 interface ClientExpires {
     TYPE: string;
-    EXPIRES: true;
+    HAS_EXPIRATION: true;
     promise?: Promise<any>;
     test?: (client: any) => boolean;
     get<T extends Serializable>(key: string): Promise<T | null> | T | null;
@@ -27,7 +32,7 @@ interface ClientExpires {
 }
 interface ClientNonExpires {
     TYPE: string;
-    EXPIRES: false;
+    HAS_EXPIRATION: false;
     promise?: Promise<any>;
     test?: (client: any) => boolean;
     get<T extends Serializable>(key: string): Promise<StoreData<T> | null> | StoreData<T> | null;
@@ -40,19 +45,21 @@ interface ClientNonExpires {
     values?<T extends Serializable>(prefix: string): Promise<StoreData<T>[]> | StoreData<T>[];
     entries?<T extends Serializable>(prefix: string): Promise<[string, StoreData<T>][]> | [string, StoreData<T>][];
     all?<T extends Serializable>(prefix: string): Promise<Record<string, StoreData<T>>> | Record<string, StoreData<T>>;
+    prune?(): Promise<any> | any;
     clear?(prefix: string): Promise<any> | any;
     clearAll?(): Promise<any> | any;
     close?(): Promise<any> | any;
 }
 type Client = ClientExpires | ClientNonExpires;
 
-declare class Store<TDefault extends Serializable = Serializable> {
+declare class Store<TD extends Serializable = Serializable> {
     #private;
-    PREFIX: string;
+    PREFIX: Prefix;
+    EXPIRES: Expires;
     promise: Promise<Client> | null;
     client: Client;
     type: string;
-    constructor(clientPromise?: any);
+    constructor(clientPromise?: any, options?: Options);
     /**
      * Save the data on an autogenerated key, can add expiration as well:
      *
@@ -64,8 +71,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .add() Docs](https://polystore.dev/documentation#add)**
      */
-    add(value: TDefault, ttl?: Expires): Promise<string>;
-    add<T extends TDefault>(value: T, ttl?: Expires): Promise<string>;
+    add(value: TD, options?: Options): Promise<string>;
+    add<T extends TD>(value: T, options?: Options): Promise<string>;
     /**
      * Save the data on the given key, can add expiration as well:
      *
@@ -77,8 +84,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .set() Docs](https://polystore.dev/documentation#set)**
      */
-    set(key: string, value: TDefault, ttl?: Expires): Promise<string>;
-    set<T extends TDefault>(key: string, value: T, ttl?: Expires): Promise<string>;
+    set(key: string, value: TD, options?: Options): Promise<string>;
+    set<T extends TD>(key: string, value: T, options?: Options): Promise<string>;
     /**
      * Read a single value from the KV store:
      *
@@ -93,8 +100,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .get() Docs](https://polystore.dev/documentation#get)**
      */
-    get(key: string): Promise<TDefault | null>;
-    get<T extends TDefault>(key: string): Promise<T | null>;
+    get(key: string): Promise<TD | null>;
+    get<T extends TD>(key: string): Promise<T | null>;
     /**
      * Check whether a key exists or not:
      *
@@ -144,8 +151,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full Iterator Docs](https://polystore.dev/documentation#iterator)**
      */
-    [Symbol.asyncIterator](): AsyncGenerator<[string, TDefault], void, unknown>;
-    [Symbol.asyncIterator]<T extends TDefault>(): AsyncGenerator<[
+    [Symbol.asyncIterator](): AsyncGenerator<[string, TD], void, unknown>;
+    [Symbol.asyncIterator]<T extends TD>(): AsyncGenerator<[
         string,
         T
     ], void, unknown>;
@@ -162,8 +169,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .entries() Docs](https://polystore.dev/documentation#entries)**
      */
-    entries(): Promise<[string, TDefault][]>;
-    entries<T extends TDefault>(): Promise<[string, T][]>;
+    entries(): Promise<[string, TD][]>;
+    entries<T extends TD>(): Promise<[string, T][]>;
     /**
      * Return an array of the keys in the store:
      *
@@ -191,8 +198,8 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .values() Docs](https://polystore.dev/documentation#values)**
      */
-    values(): Promise<TDefault[]>;
-    values<T extends TDefault>(): Promise<T[]>;
+    values(): Promise<TD[]>;
+    values<T extends TD>(): Promise<T[]>;
     /**
      * Return an object with the keys:values in the store:
      *
@@ -206,20 +213,24 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .all() Docs](https://polystore.dev/documentation#all)**
      */
-    all(): Promise<Record<string, TDefault>>;
-    all<T extends TDefault>(): Promise<Record<string, T>>;
+    all(): Promise<Record<string, TD>>;
+    all<T extends TD>(): Promise<Record<string, T>>;
     /**
-     * Delete all of the records of the store:
+     * Create a substore where all the keys are stored with
+     * the given prefix:
      *
      * ```js
-     * await store.clear();
+     * const session = store.prefix("session:");
+     * await session.set("key1", "value1");
+     * console.log(await session.entries());  // session.
+     * // [["key1", "value1"]]
+     * console.log(await store.entries());  // store.
+     * // [["session:key1", "value1"]]
      * ```
      *
-     * It's useful for cache invalidation, clearing the data, and testing.
-     *
-     * **[→ Full .clear() Docs](https://polystore.dev/documentation#clear)**
+     * **[→ Full .prefix() Docs](https://polystore.dev/documentation#prefix)**
      */
-    clear(): Promise<void>;
+    prefix(prefix?: Prefix): Store<TD>;
     /**
      * Create a substore where all the keys are stored with
      * the given prefix:
@@ -235,7 +246,29 @@ declare class Store<TDefault extends Serializable = Serializable> {
      *
      * **[→ Full .prefix() Docs](https://polystore.dev/documentation#prefix)**
      */
-    prefix(prefix?: string): Store<TDefault>;
+    expires(expires?: Expires): Store<TD>;
+    /**
+     * Delete all of the records of the store:
+     *
+     * ```js
+     * await store.clear();
+     * ```
+     *
+     * It's useful for cache invalidation, clearing the data, and testing.
+     *
+     * **[→ Full .clear() Docs](https://polystore.dev/documentation#clear)**
+     */
+    clear(): Promise<void>;
+    /**
+     * Remove all expired records from the store.
+     *
+     * ```js
+     * await store.prune();
+     * ```
+     *
+     * Only affects stores where expiration is managed by this wrapper.
+     */
+    prune(): Promise<void>;
     /**
      * Stop the connection to the store, if any:
      *
@@ -250,6 +283,6 @@ declare class Store<TDefault extends Serializable = Serializable> {
     close(): Promise<void>;
 }
 declare function createStore(): Store<Serializable>;
-declare function createStore<T extends Serializable = Serializable>(client?: any): Store<T>;
+declare function createStore<T extends Serializable = Serializable>(client?: any, options?: Options): Store<T>;
 
 export { type Client, type Serializable, Store, createStore as default };