polystore 0.21.2 → 0.22.0

package/index.d.ts

@@ -11,11 +11,11 @@ type StoreData<T extends Serializable = Serializable> = {
 type Serializable = string | number | boolean | null | (Serializable | null)[] | {
     [key: string]: Serializable | null;
 };
-interface ClientExpires {
+interface AdapterExpires {
     TYPE: string;
     HAS_EXPIRATION: true;
     promise?: Promise<any>;
-    test?: (client: any) => boolean;
+    test?: (raw: any) => boolean;
     get<T extends Serializable>(key: string): Promise<T | null> | T | null;
     set<T extends Serializable>(key: string, value: T, expires?: Expires): Promise<any> | any;
     iterate<T extends Serializable>(prefix: string): AsyncGenerator<[string, T], void, unknown> | Generator<[string, T], void, unknown>;
@@ -30,11 +30,11 @@ interface ClientExpires {
     clearAll?(): Promise<any> | any;
     close?(): Promise<any> | any;
 }
-interface ClientNonExpires {
+interface AdapterNonExpires {
     TYPE: string;
     HAS_EXPIRATION: false;
     promise?: Promise<any>;
-    test?: (client: any) => boolean;
+    test?: (raw: any) => boolean;
     get<T extends Serializable>(key: string): Promise<StoreData<T> | null> | StoreData<T> | null;
     set<T extends Serializable>(key: string, value: StoreData<T> | null, ttl?: Expires): Promise<any> | any;
     iterate<T extends Serializable>(prefix: string): AsyncGenerator<[string, StoreData<T>], void, unknown> | Generator<[string, StoreData<T>], void, unknown>;
@@ -50,16 +50,16 @@ interface ClientNonExpires {
     clearAll?(): Promise<any> | any;
     close?(): Promise<any> | any;
 }
-type Client = ClientExpires | ClientNonExpires;
+type Adapter = AdapterExpires | AdapterNonExpires;
 
 declare class Store<TD extends Serializable = Serializable> {
     #private;
     PREFIX: Prefix;
     EXPIRES: Expires;
-    promise: Promise<Client> | null;
-    client: Client;
+    promise: Promise<Adapter> | null;
+    adapter: Adapter;
     type: string;
-    constructor(clientPromise?: any, options?: Options);
+    constructor(adapterInput?: any, options?: Options);
     /**
      * Save the data on an autogenerated key, can add expiration as well:
      *
@@ -141,7 +141,7 @@ declare class Store<TD extends Serializable = Serializable> {
      */
     delete(key: string): Promise<string>;
     /**
-     * An iterator that goes through all of the key:value pairs in the client
+     * An iterator that goes through all of the key:value pairs in the store
      *
      * ```js
      * for await (const [key, value] of store) {
@@ -283,6 +283,6 @@ declare class Store<TD extends Serializable = Serializable> {
     close(): Promise<void>;
 }
 declare function createStore(): Store<Serializable>;
-declare function createStore<T extends Serializable = Serializable>(client?: any, options?: Options): Store<T>;
+declare function createStore<T extends Serializable = Serializable>(adapter?: any, options?: Options): Store<T>;
 
-export { type Client, type Serializable, Store, createStore as default };
+export { type Adapter, type Serializable, Store, createStore as default };