@samet-it/be-redis-common 1.1.1 → 1.1.2

package/dist/channel/index.types.d.ts

@@ -5,8 +5,12 @@ import type { RedisClientType } from "redis";
 import type { KeyValue } from "@leyyo/common";
 /**
  * Redis channel interface
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
-export interface RedisChannelLike<ID extends KeyValue, ENTITY extends Entity<ID>> extends CacheChannelLike<RedisConnectionLike, ID, ENTITY> {
+export interface RedisChannelLike<ENT extends Entity<ID>, ID extends KeyValue> extends CacheChannelLike<RedisConnectionLike, ENT, ID> {
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
 }

package/dist/channel/redis-direct.channel.d.ts

@@ -5,8 +5,12 @@ import type { RedisDirectChannelOpt } from "./index.types";
 import type { KeyValue } from "@leyyo/common";
 /**
  * Redis direct channel class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
-export declare class RedisDirectChannel<ID extends KeyValue, ENTITY extends Entity<ID>> extends RedisChannel<ID, ENTITY> {
+export declare class RedisDirectChannel<ENT extends Entity<ID>, ID extends KeyValue> extends RedisChannel<ENT, ID> {
     /**
      * Constructor
      *

package/dist/channel/redis-direct.channel.js

@@ -5,6 +5,10 @@ const redis_channel_1 = require("./redis.channel");
 const be_base_common_1 = require("@samet-it/be-base-common");
 /**
  * Redis direct channel class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
 class RedisDirectChannel extends redis_channel_1.RedisChannel {
     /**

package/dist/channel/redis.channel.d.ts

@@ -5,12 +5,28 @@ import { CacheChannel } from "@samet-it/be-cache-common";
 import type { KeyValue, Opt } from "@leyyo/common";
 /**
  * Redis abstract channel class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
-export declare abstract class RedisChannel<ID extends KeyValue, ENTITY extends Entity<ID>> extends CacheChannel<RedisConnectionLike, ID, ENTITY> implements RedisChannelLike<ID, ENTITY> {
+export declare abstract class RedisChannel<ENT extends Entity<ID>, ID extends KeyValue> extends CacheChannel<RedisConnectionLike, ENT, ID> implements RedisChannelLike<ENT, ID> {
     /** @inheritDoc */
     protected _props: RedisChannelProps;
+    /**
+     * Constructor
+     *
+     * @param {RedisConnectionLike} conn - redis connection
+     * @param {RedisChannelOpt} opt - options
+     * */
     protected constructor(conn: RedisConnectionLike, opt?: RedisChannelOpt);
-    protected _checkError(e: Error, opt?: Opt): void;
+    /**
+     * @Check error
+     *
+     * @param {Error} e - error instance
+     * @param {Opt} params - parameters
+     * */
+    protected _checkError(e: Error, params?: Opt): void;
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
     /** @inheritDoc */

package/dist/channel/redis.channel.js

@@ -15,9 +15,19 @@ const be_cache_common_1 = require("@samet-it/be-cache-common");
 // noinspection JSUnusedGlobalSymbols
 /**
  * Redis abstract channel class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
 class RedisChannel extends be_cache_common_1.CacheChannel {
     // endregion protected-property
+    /**
+     * Constructor
+     *
+     * @param {RedisConnectionLike} conn - redis connection
+     * @param {RedisChannelOpt} opt - options
+     * */
     constructor(conn, opt) {
         super(conn, opt);
         conn.onFirstConnected(() => __awaiter(this, void 0, void 0, function* () {
@@ -33,16 +43,24 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
             this._props.isConnected = false;
         }));
     }
-    _checkError(e, opt) {
+    // region protected-methods
+    /**
+     * @Check error
+     *
+     * @param {Error} e - error instance
+     * @param {Opt} params - parameters
+     * */
+    _checkError(e, params) {
         be_base_common_1.errorHandler.addStat(e);
         if (e instanceof be_cache_common_1.CacheError) {
             // todo append params
             throw e;
         }
         else {
-            throw be_base_common_1.errorHandler.common.castForClass(be_cache_common_1.CacheError, e, opt);
+            throw be_base_common_1.errorHandler.common.castForClass(be_cache_common_1.CacheError, e, params);
         }
     }
+    // endregion protected-methods
     // region getter
     /** @inheritDoc */
     get props() {

package/dist/connection/index.types.d.ts

@@ -18,10 +18,14 @@ export interface RedisDirectConnectionLike extends RedisConnectionLike {
     /**
      * Create new channel
      *
+     * Generics:
+     * - 0-`ENT`: entity {@link Entity}
+     * - 1-`ID`: id type {@link KeyValue}
+     *
      * @param {RedisDirectChannelOpt?} opt - direct channel options
      * @return {RedisChannelLike<Entity>} - new channel
      * */
-    newChannel<ID extends KeyValue, ENTITY extends Entity<ID>>(opt?: RedisDirectChannelOpt): RedisChannelLike<ID, ENTITY>;
+    newChannel<ENT extends Entity<ID>, ID extends KeyValue>(opt?: RedisDirectChannelOpt): RedisChannelLike<ENT, ID>;
 }
 /**
  * Redis connection option

package/dist/connection/redis-direct.connection.d.ts

@@ -14,5 +14,5 @@ export declare class RedisDirectConnection extends RedisConnection implements Re
      * */
     constructor(opt?: RedisConnDirectOpt);
     /** @inheritDoc */
-    newChannel<ID extends KeyValue, ENTITY extends Entity<ID>>(opt?: RedisDirectChannelOpt): RedisChannelLike<ID, ENTITY>;
+    newChannel<ENT extends Entity<ID>, ID extends KeyValue>(opt?: RedisDirectChannelOpt): RedisChannelLike<ENT, ID>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-redis-common",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Redis common component",
   "keywords": [
     "redis",
@@ -70,7 +70,7 @@
     "@leyyo/common": "^1.2.1",
     "@leyyo/env": "^1.2.1",
     "@samet-it/be-base-common": "^1.1.1",
-    "@samet-it/be-cache-common": "^1.1.1",
+    "@samet-it/be-cache-common": "^1.1.2",
     "redis": "^5.10.0"
   }
 }