@bett3r-dev/pv3-types 1.0.0 → 1.11.0

package/build/cache.d.ts

@@ -8,7 +8,7 @@ export type CacheAdapter<T = any> = CacheType & AdapterBase<T> & {
 /**
  * @category Main Types
  */
-export type CachePort = PortEmitter & CacheType;
+export type CachePort<T = any> = PortEmitter & CacheAdapter<T>;
 /**
  * @hidden
  */
@@ -38,10 +38,20 @@ export declare function remove(key: string): Promise<void>;
  */
 export declare function incrementBy(key: string, value: number): Promise<number>;
 /**
+ * INCRBY + EXPIRE in an atomic Redis pipeline. Returns the new count.
+ * TTL is applied on every call (sliding window).
  * @category Cache Port
- * @param function
  */
-export declare function memoize<F extends Function>(func: F, expirationSeconds?: number | false): F;
+export declare function incrementByWithExpiry(key: string, value: number, expirationSeconds: number): Promise<number>;
+/**
+ * @category Cache Port
+ * @param func The function to memoize
+ * @param expirationSeconds TTL for the cache, in case of `false` passed, the cache would not expire
+ * @param expireOnlyIfUnused If true, only expire if the cache hasn't been accessed
+ */
+export declare function memoize<F extends (...args: any[]) => any>(func: F, expirationSeconds: number | false, expireOnlyIfUnused?: boolean): F & {
+    invalidate: (...args: Parameters<F>) => Promise<void>;
+};
 /**
  * @category Cache Port
  * @param pattern
@@ -52,6 +62,11 @@ export declare function keys(pattern: string): Promise<string[]>;
  * @category Cache Port
  * */
 export declare function hashExists(key: string, hash: string): Promise<boolean>;
+/**
+ * HLEN
+ * @category Cache Port
+ * */
+export declare function hashLength(key: string): Promise<number>;
 /** HGET */
 export declare function hashGet<T>(key: string, hash: string): Promise<T>;
 /**
@@ -74,12 +89,37 @@ export declare function hashSetIfNotExists<T>(key: string, hash: string, value:
  * HINCRBY
  * @category Cache Port
  * */
-export declare function hashIncrementBy(key: string, hash: string, value: number): Promise<boolean>;
+export declare function hashIncrementBy(key: string, hash: string, value: number): Promise<number>;
 /**
  * HDEL
  * @category Cache Port
  * */
 export declare function hashDel(key: string, hash: string): Promise<boolean>;
+/**
+ * SETBIT
+ * @category Cache Port
+ * */
+export declare function setBit(key: string, offset: number | string, value: number | string): Promise<void>;
+/**
+ * GETBIT
+ * @category Cache Port
+ * */
+export declare function getBit(key: string, offset: number | string): Promise<boolean>;
+/**
+ * RPUSH — atomically appends one or more values to a list
+ * @category Cache Port
+ * @param key The list key
+ * @param values The values to append (JSON-stringified internally)
+ * @returns The length of the list after the push
+ */
+export declare function listPush<T>(key: string, ...values: T[]): Promise<number>;
+/**
+ * LRANGE 0 -1 — returns all elements of a list
+ * @category Cache Port
+ * @param key The list key
+ * @returns All elements in the list
+ */
+export declare function listGetAll<T>(key: string): Promise<T[]>;
 /**
  * @category Main Types
  */
@@ -90,12 +130,18 @@ export type CacheType = {
     memoize: typeof memoize;
     remove: typeof remove;
     incrementBy: typeof incrementBy;
+    incrementByWithExpiry: typeof incrementByWithExpiry;
     hashExists: typeof hashExists;
+    hashLength: typeof hashLength;
     hashGet: typeof hashGet;
     hashGetAll: typeof hashGetAll;
     hashSet: typeof hashSet;
     hashSetIfNotExists: typeof hashSetIfNotExists;
     hashIncrementBy: typeof hashIncrementBy;
+    setBit: typeof setBit;
+    getBit: typeof getBit;
     hashDel: typeof hashDel;
+    listPush: typeof listPush;
+    listGetAll: typeof listGetAll;
 };
 //# sourceMappingURL=cache.d.ts.map

package/build/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,GAAG,IAAI,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG;IAC/D,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAG,GAAG,EAAE,MAAM,GAAK,CAAE,KAAK,EAAE,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,KAAM,OAAO,CAAC,CAAC,CAAC,CAAA;AAC5I;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAI,OAAO,CAAC,CAAC,CAAC,CAAA;AACvG;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,CAAC,CAAA;AACzD;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAE,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5D;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAE,GAAG,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,CAAA;AACjF;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,SAAS,QAAQ,EAAG,IAAI,EAAE,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAI,CAAC,CAAA;AAErG;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAE,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;AAKlE;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAA;AAChF,WAAW;AACX,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,CAAC,CAAC,CAAA;AAC1E;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAE,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AAClF;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAI,OAAO,CAAC,OAAO,CAAC,CAAA;AAC1F;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAI,OAAO,CAAC,OAAO,CAAC,CAAA;AACrG;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,eAAe,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAA;AACpG;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAA;AAE7E;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,OAAO,GAAG,CAAA;IACf,GAAG,EAAE,OAAO,GAAG,CAAA;IACf,IAAI,EAAE,OAAO,IAAI,CAAA;IACjB,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,MAAM,EAAE,OAAO,MAAM,CAAA;IACrB,WAAW,EAAE,OAAO,WAAW,CAAA;IAC/B,UAAU,EAAE,OAAO,UAAU,CAAA;IAC7B,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,UAAU,EAAE,OAAO,UAAU,CAAA;IAC7B,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,kBAAkB,EAAE,OAAO,kBAAkB,CAAA;IAC7C,eAAe,EAAE,OAAO,eAAe,CAAA;IACvC,OAAO,EAAE,OAAO,OAAO,CAAA;CACxB,CAAA"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,GAAG,IAAI,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG;IAC/D,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,GAAG,IAAI,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAG,GAAG,EAAE,MAAM,GAAK,CAAE,KAAK,EAAE,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,KAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAC7I;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AACxG;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1D;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAE,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAC7D;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAE,GAAG,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,CAAC;AAClF;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,CAAC;AACxH;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,SAAS,CAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAG,IAAI,EAAE,CAAC,EAAE,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAI,CAAC,GAAG;IAAE,UAAU,EAAE,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC;AAEjN;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAE,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAKnE;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AACjF;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,UAAU,CAAE,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,CAAC;AACnE,WAAW;AACX,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3E;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAE,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACnF;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAC3F;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AACtG;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,eAAe,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC,CAAC;AACpG;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAC9E;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9G;;;KAGK;AACL,MAAM,CAAC,OAAO,UAAU,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAKzF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACnF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,CAAC,EAAG,GAAG,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,OAAO,GAAG,CAAA;IACf,GAAG,EAAE,OAAO,GAAG,CAAA;IACf,IAAI,EAAE,OAAO,IAAI,CAAA;IACjB,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,MAAM,EAAE,OAAO,MAAM,CAAA;IACrB,WAAW,EAAE,OAAO,WAAW,CAAA;IAC/B,qBAAqB,EAAE,OAAO,qBAAqB,CAAA;IACnD,UAAU,EAAE,OAAO,UAAU,CAAA;IAC7B,UAAU,EAAE,OAAO,UAAU,CAAA;IAC7B,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,UAAU,EAAE,OAAO,UAAU,CAAA;IAC7B,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,kBAAkB,EAAE,OAAO,kBAAkB,CAAA;IAC7C,eAAe,EAAE,OAAO,eAAe,CAAA;IACvC,MAAM,EAAE,OAAO,MAAM,CAAA;IACrB,MAAM,EAAE,OAAO,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,OAAO,CAAA;IACvB,QAAQ,EAAE,OAAO,QAAQ,CAAA;IACzB,UAAU,EAAE,OAAO,UAAU,CAAA;CAC9B,CAAC"}