@qelos/cache-manager 3.0.1 → 3.2.0

package/README.md

@@ -1,3 +1,56 @@
 # @qelos/cache-manager
 
 cache manager library for backend services, using redis or internal memory.
+
+## Simple Installation Example
+
+### Install
+```bash
+$ npm install @qelos/cache-manager
+```
+
+```typescript
+import {createCacheManager} from '@qelos/cache-manager';
+import {redisUrl} from './config';
+
+const cacher = redisUrl ?
+  require('@qelos/cache-manager/dist/redis-cache').createRedisCache(redisUrl) :
+  require('@qelos/cache-manager/dist/memory-cache').createMemoryCache()
+
+const cacheManager = createCacheManager(cacher);
+```
+
+## Get item from cache
+```typescript
+const value = await cacheManager.getItem('your-cache-key');
+```
+
+## Set item to cache
+The value must in a string
+```typescript
+
+await cacheManager.setItem('your-cache-key', 'new value to store in cache');
+```
+
+
+## Wrap a fallback to get an item
+
+In this method, you can specify a key.
+If the key doesn't exist inside the cache store, it will fall back to the function, return its value and store it inside the cache store.
+
+```typescript
+const value = await cacheManager.wrap('your-cache-key', async () => {
+  const data = await someDatabase.query('select * from MyTable where id = X')
+  return JSON.stringify(data);
+});
+```
+
+### Custom cache options
+
+
+```typescript
+
+await cacheManager.setItem('your-cache-key', 'new value to store in cache', {
+  ttl: 1000 // in seconds
+});
+```

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CacheManagerOptions } from "./cache-manager-options";
 import { ICache } from "./cache-type";
-export declare type IDataProviderCallback = () => string | Promise<string>;
+export type IDataProviderCallback = () => string | Promise<string>;
 export interface CacheManager {
     getItem: (key: string) => Promise<string>;
     setItem: (key: string, value: string, { ttl }?: CacheManagerOptions) => Promise<void>;

package/dist/redis-cache.js

@@ -4,7 +4,7 @@ exports.createRedisCache = void 0;
 const util_1 = require("util");
 const redis_1 = require("redis");
 function createRedisCache(redisUrl) {
-    const client = (0, redis_1.createClient)(redisUrl);
+    const client = (0, redis_1.createClient)({ url: redisUrl });
     client.on("connect", function () {
         console.log('redis is connected for cache manager');
     });

package/dist/redis-cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis-cache.js","sourceRoot":"","sources":["../redis-cache.ts"],"names":[],"mappings":";;;AACA,+BAAiC;AACjC,iCAAqC;AAGrC,SAAgB,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE;QACjB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK;QAC9B,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEnD,OAAO;QACH,OAAO;QACP,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE,GAAG,EAAuB;YAClE,MAAM,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC3B;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AArBD,4CAqBC"}
+{"version":3,"file":"redis-cache.js","sourceRoot":"","sources":["../redis-cache.ts"],"names":[],"mappings":";;;AACA,+BAAiC;AACjC,iCAAqC;AAGrC,SAAgB,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,EAAC,GAAG,EAAE,QAAQ,EAAC,CAAC,CAAC;IAC7C,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE;QACjB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK;QAC9B,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEnD,OAAO;QACH,OAAO;QACP,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE,GAAG,EAAuB;YAClE,MAAM,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC3B;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AArBD,4CAqBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qelos/cache-manager",
-  "version": "3.0.1",
+  "version": "3.2.0",
   "description": "",
   "main": "./dist/index.js",
   "private": false,
@@ -11,11 +11,11 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "redis": "3.0.2"
+    "redis": "4.6.5"
   },
   "devDependencies": {
-    "@types/redis": "^2.8.31",
-    "typescript": "^4.6.3"
+    "@types/redis": "^4.0.11",
+    "typescript": "^4.9.5"
   },
   "publishConfig": {
     "access": "public"

package/redis-cache.ts

@@ -4,7 +4,7 @@ import { createClient } from 'redis';
 import { CacheManagerOptions } from "./cache-manager-options";
 
 export function createRedisCache(redisUrl: string): ICache {
-    const client = createClient(redisUrl);
+    const client = createClient({url: redisUrl});
     client.on("connect", function () {
         console.log('redis is connected for cache manager');
     });