@boredland/node-ts-cache 6.0.0 → 6.0.2

package/README.md

@@ -22,6 +22,7 @@ _Note: The underlying storage layer must be installed separately._
 | [node-fs](https://www.npmjs.com/package/@boredland/node-ts-cache-storage-node-fs)| ```yarn add @boredland/node-ts-cache-storage-node-fs```|
 | [ioredis](https://www.npmjs.com/package/@boredland/node-ts-cache-storage-ioredis)| ```yarn add @boredland/node-ts-cache-storage-ioredis```|
 | [postgres](https://www.npmjs.com/package/@boredland/node-ts-cache-storage-pg)| ```yarn add @boredland/node-ts-cache-storage-pg```|
+| [elasticsearch](https://www.npmjs.com/package/@boredland/node-ts-cache-storage-elasticsearch)| ```yarn add @boredland/node-ts-cache-storage-elasticsearch```|
 
 ## Usage
 

package/dist/{cache-container/cache-container-types.d.ts → cacheContainer.d.ts}

@@ -1,3 +1,4 @@
+import type { Storage } from "./storage";
 export declare type CachedItem<T = any> = {
     content: T;
     meta: {
@@ -23,3 +24,18 @@ export declare type CachingOptions = {
         args: any[];
     }) => string;
 };
+export declare class CacheContainer {
+    private storage;
+    constructor(storage: Storage);
+    getItem<T>(key: string): Promise<{
+        content: T;
+        meta: {
+            expired: boolean;
+            createdAt: number;
+        };
+    } | undefined>;
+    setItem(key: string, content: unknown, options?: Partial<CachingOptions>): Promise<void>;
+    clear(): Promise<void>;
+    private isItemExpired;
+    unsetKey(key: string): Promise<void>;
+}

package/dist/decorator.d.ts

@@ -0,0 +1,8 @@
+import type { CacheContainer, CachingOptions } from "./cacheContainer";
+/**
+ * Decorator to be used on class methods to be cached
+ * @param container - container instance to be used for the method
+ * @param options - caching options to be used for the method
+ * @returns the return value of the method, cached or otherwise
+ */
+export declare function Cache(container: CacheContainer, options?: Partial<CachingOptions>): MethodDecorator;

package/dist/{decorator/cache-decorator.js → decorator.js}

@@ -9,6 +9,12 @@ const debug = (0, debug_1.default)("node-ts-cache");
 const jsonCalculateKey = (data) => {
     return `${data.className}:${data.methodName}:${JSON.stringify(data.args)}`;
 };
+/**
+ * Decorator to be used on class methods to be cached
+ * @param container - container instance to be used for the method
+ * @param options - caching options to be used for the method
+ * @returns the return value of the method, cached or otherwise
+ */
 function Cache(container, options) {
     return function (target, methodName, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./decorator";
 export * from "./storage";
-export * from "./cache-container";
+export * from "./cacheContainer";
 export * from "./withCache";

package/dist/index.js

@@ -16,5 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./decorator"), exports);
 __exportStar(require("./storage"), exports);
-__exportStar(require("./cache-container"), exports);
+__exportStar(require("./cacheContainer"), exports);
 __exportStar(require("./withCache"), exports);

package/dist/storage.d.ts

@@ -0,0 +1,23 @@
+import type { CachedItem } from ".";
+export interface Storage {
+    /**
+     * returns a cached item from the storage layer
+     * @param key - key to look up
+     */
+    getItem(key: string): Promise<CachedItem | undefined>;
+    /**
+     * sets a cached item on the storage layer
+     * @param key - key to store
+     * @param content - content to store, including some meta data
+     */
+    setItem(key: string, content: CachedItem): Promise<void>;
+    /**
+     * removes item from the storage layer
+     * @param key - key to remove
+     */
+    removeItem(key: string): Promise<void>;
+    /**
+     * remove all keys from the storage layer
+     */
+    clear(): Promise<void>;
+}

package/dist/withCache.d.ts

@@ -1,4 +1,4 @@
-import type { CacheContainer, CachingOptions } from "./cache-container";
+import type { CacheContainer, CachingOptions } from "./cacheContainer";
 declare type WithCacheOptions<Parameters> = Partial<Omit<CachingOptions, "calculateKey">> & {
     /** an optional prefix to prepend to the key */
     prefix?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@boredland/node-ts-cache",
   "description": "Simple and extensible caching module supporting decorators",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "private": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/cache-container/cache-container.d.ts

@@ -1,17 +0,0 @@
-import type { Storage } from "../storage";
-import type { CachingOptions } from "./cache-container-types";
-export declare class CacheContainer {
-    private storage;
-    constructor(storage: Storage);
-    getItem<T>(key: string): Promise<{
-        content: T;
-        meta: {
-            expired: boolean;
-            createdAt: number;
-        };
-    } | undefined>;
-    setItem(key: string, content: unknown, options?: Partial<CachingOptions>): Promise<void>;
-    clear(): Promise<void>;
-    private isItemExpired;
-    unsetKey(key: string): Promise<void>;
-}

package/dist/cache-container/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./cache-container";
-export * from "./cache-container-types";

package/dist/cache-container/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./cache-container"), exports);
-__exportStar(require("./cache-container-types"), exports);

package/dist/decorator/cache-decorator.d.ts

@@ -1,2 +0,0 @@
-import type { CacheContainer, CachingOptions } from "../cache-container";
-export declare function Cache(container: CacheContainer, options?: Partial<CachingOptions>): MethodDecorator;

package/dist/decorator/index.d.ts

@@ -1 +0,0 @@
-export * from "./cache-decorator";

package/dist/decorator/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./cache-decorator"), exports);

package/dist/storage/index.d.ts

@@ -1 +0,0 @@
-export * from "./storage-types";

package/dist/storage/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./storage-types"), exports);

package/dist/storage/storage-types.d.ts

@@ -1,7 +0,0 @@
-import type { CachedItem } from "../cache-container";
-export interface Storage {
-    getItem(key: string): Promise<CachedItem | undefined>;
-    setItem(key: string, content: CachedItem): Promise<void>;
-    removeItem(key: string): Promise<void>;
-    clear(): Promise<void>;
-}

package/dist/storage/storage-types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });