@m3ftwz/redisfx 1.0.0 → 1.2.0

package/README.md

@@ -34,26 +34,47 @@ const { redisfx } = require('@m3ftwz/redisfx');
 ```js
 // Callback style
 redisfx.get('player:1:name', (result) => {
-    console.log(result)
-})
+  console.log(result);
+});
 
 // Promise style
-redisfx.get('player:1:name').then((result) => {
-    console.log(result)
-}).catch(console.error)
+redisfx
+  .get('player:1:name')
+  .then((result) => {
+    console.log(result);
+  })
+  .catch(console.error);
 
 // Async/await
-const result = await redisfx.get('player:1:name').catch(console.error)
-console.log(result)
+const result = await redisfx.get('player:1:name').catch(console.error);
+console.log(result);
 
 // Hash operations
-await redisfx.hset('player:1', 'money', 1000)
-const money = await redisfx.hget('player:1', 'money')
+await redisfx.hset('player:1', 'money', 1000);
+const money = await redisfx.hget('player:1', 'money');
 
 // Set with expiry
-await redisfx.set('session:abc', 'data', { EX: 3600 })
+await redisfx.set('session:abc', 'data', { EX: 3600 });
+
+// Hash field expiry (Redis 7.4+)
+await redisfx.hexpire('player:1', 'session', 300);
+
+// Pub/sub - messages arrive as the `redisfx:message` server event
+await redisfx.subscribe('chat:global');
+await redisfx.publish('chat:global', 'hello');
+
+// MULTI/EXEC
+await redisfx.multi([
+  { command: 'SET', args: ['a', '1'] },
+  { command: 'INCR', args: ['a'] },
+]);
+
+// Anything without a named export
+await redisfx.raw('GEOADD', ['places', 13.361389, 38.115556, 'Palermo']);
 ```
 
+See the [full command reference](https://github.com/m3ftwz/redisfx#commands-reference).
+
 ## License
 
 LGPL-3.0

package/Redis.d.ts

@@ -19,6 +19,22 @@ interface ZAddOptions {
 interface ScanOptions {
     MATCH?: string;
     COUNT?: number;
+    TYPE?: string;
+}
+interface SubscribeOptions {
+    /** Treat the channels as glob patterns (PSUBSCRIBE). */
+    pattern?: boolean;
+    /** Use sharded pub/sub (SSUBSCRIBE, Redis 7.0+). */
+    sharded?: boolean;
+}
+/** Cursor reply shared by SCAN/HSCAN/SSCAN/ZSCAN. */
+interface ScanReply {
+    cursor: string;
+    keys: string[];
+}
+interface ScoredMember {
+    value: string;
+    score: number;
 }
 interface RedisFX {
     isReady: () => boolean;
@@ -26,28 +42,85 @@ interface RedisFX {
     ready: (callback: () => void) => void;
     get: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
     set: <T = string | null>(key: string, value: string | number, options?: SetOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
-    del: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
-    exists: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
-    expire: <T = number>(key: string, seconds: number, cb?: Callback<T>) => Promise<T>;
-    ttl: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    getdel: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    getex: <T = string | null>(key: string, options?: SetOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    getrange: <T = string>(key: string, start: number, end: number, cb?: Callback<T>) => Promise<T>;
+    setrange: <T = number>(key: string, offset: number, value: string, cb?: Callback<T>) => Promise<T>;
+    append: <T = number>(key: string, value: string, cb?: Callback<T>) => Promise<T>;
+    strlen: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    setnx: <T = boolean>(key: string, value: string | number, cb?: Callback<T>) => Promise<T>;
     incr: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
     incrby: <T = number>(key: string, increment: number, cb?: Callback<T>) => Promise<T>;
+    incrbyfloat: <T = string>(key: string, increment: number, cb?: Callback<T>) => Promise<T>;
     decr: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
     decrby: <T = number>(key: string, decrement: number, cb?: Callback<T>) => Promise<T>;
     mget: <T = (string | null)[]>(keys: string[], cb?: Callback<T>) => Promise<T>;
     mset: <T = string>(keyValues: Record<string, string | number>, cb?: Callback<T>) => Promise<T>;
+    msetnx: <T = boolean>(keyValues: Record<string, string | number>, cb?: Callback<T>) => Promise<T>;
+    del: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    unlink: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    exists: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    touch: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    expire: <T = boolean>(key: string, seconds: number, cb?: Callback<T>) => Promise<T>;
+    pexpire: <T = boolean>(key: string, milliseconds: number, cb?: Callback<T>) => Promise<T>;
+    expireat: <T = boolean>(key: string, timestamp: number, cb?: Callback<T>) => Promise<T>;
+    pexpireat: <T = boolean>(key: string, timestamp: number, cb?: Callback<T>) => Promise<T>;
+    expiretime: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    pexpiretime: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    ttl: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    pttl: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    persist: <T = boolean>(key: string, cb?: Callback<T>) => Promise<T>;
+    type: <T = string>(key: string, cb?: Callback<T>) => Promise<T>;
+    rename: <T = string>(key: string, newKey: string, cb?: Callback<T>) => Promise<T>;
+    renamenx: <T = boolean>(key: string, newKey: string, cb?: Callback<T>) => Promise<T>;
+    randomkey: <T = string | null>(cb?: Callback<T>) => Promise<T>;
+    keys: <T = string[]>(pattern: string, cb?: Callback<T>) => Promise<T>;
+    copy: <T = boolean>(source: string, destination: string, options?: {
+        DB?: number;
+        REPLACE?: boolean;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    scan: <T = ScanReply>(cursor: string | number, options?: ScanOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    objectEncoding: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    memoryUsage: <T = number | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    dump: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    restore: <T = string>(key: string, ttl: number, serialized: string, cb?: Callback<T>) => Promise<T>;
+    blessSet: <T = number>(key: string, flag: 'NO-EVICT', cb?: Callback<T>) => Promise<T>;
+    blessGet: <T = string[]>(key: string, cb?: Callback<T>) => Promise<T>;
+    blessClear: <T = number>(key: string, flag: 'NO-EVICT', cb?: Callback<T>) => Promise<T>;
+    blessScan: <T = ScanReply>(cursor: string | number, flag: 'NO-EVICT', options?: {
+        COUNT?: number;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
     hget: <T = string | null>(key: string, field: string, cb?: Callback<T>) => Promise<T>;
     hset: <T = number>(key: string, field: string, value: string | number, cb?: Callback<T>) => Promise<T>;
+    hsetnx: <T = boolean>(key: string, field: string, value: string | number, cb?: Callback<T>) => Promise<T>;
     hmset: <T = number>(key: string, fieldValues: Record<string, string | number>, cb?: Callback<T>) => Promise<T>;
     hgetall: <T = Record<string, string>>(key: string, cb?: Callback<T>) => Promise<T>;
+    hmget: <T = (string | null)[]>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
     hdel: <T = number>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
     hincrby: <T = number>(key: string, field: string, increment: number, cb?: Callback<T>) => Promise<T>;
-    hexists: <T = number>(key: string, field: string, cb?: Callback<T>) => Promise<T>;
+    hincrbyfloat: <T = string>(key: string, field: string, increment: number, cb?: Callback<T>) => Promise<T>;
+    hexists: <T = boolean>(key: string, field: string, cb?: Callback<T>) => Promise<T>;
     hkeys: <T = string[]>(key: string, cb?: Callback<T>) => Promise<T>;
     hvals: <T = string[]>(key: string, cb?: Callback<T>) => Promise<T>;
     hlen: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    hstrlen: <T = number>(key: string, field: string, cb?: Callback<T>) => Promise<T>;
+    hrandfield: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    hscan: <T = ScanReply>(key: string, cursor: string | number, options?: ScanOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    hexpire: <T = number[]>(key: string, fields: string | string[], seconds: number, cb?: Callback<T>) => Promise<T>;
+    hpexpire: <T = number[]>(key: string, fields: string | string[], milliseconds: number, cb?: Callback<T>) => Promise<T>;
+    hexpireat: <T = number[]>(key: string, fields: string | string[], timestamp: number, cb?: Callback<T>) => Promise<T>;
+    hpexpireat: <T = number[]>(key: string, fields: string | string[], timestamp: number, cb?: Callback<T>) => Promise<T>;
+    httl: <T = number[]>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
+    hpttl: <T = number[]>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
+    hpersist: <T = number[]>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
+    /** HGETEX (Redis 8.0+) - read fields and optionally reset their TTL. */
+    hgetex: <T = (string | null)[]>(key: string, fields: string | string[], options?: SetOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    /** HGETDEL (Redis 8.0+) - read fields and delete them atomically. */
+    hgetdel: <T = (string | null)[]>(key: string, fields: string | string[], cb?: Callback<T>) => Promise<T>;
     lpush: <T = number>(key: string, values: string | string[], cb?: Callback<T>) => Promise<T>;
     rpush: <T = number>(key: string, values: string | string[], cb?: Callback<T>) => Promise<T>;
+    lpushx: <T = number>(key: string, values: string | string[], cb?: Callback<T>) => Promise<T>;
+    rpushx: <T = number>(key: string, values: string | string[], cb?: Callback<T>) => Promise<T>;
     lpop: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
     rpop: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
     lrange: <T = string[]>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
@@ -55,36 +128,119 @@ interface RedisFX {
     lindex: <T = string | null>(key: string, index: number, cb?: Callback<T>) => Promise<T>;
     lset: <T = string>(key: string, index: number, value: string, cb?: Callback<T>) => Promise<T>;
     lrem: <T = number>(key: string, count: number, value: string, cb?: Callback<T>) => Promise<T>;
+    ltrim: <T = string>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
+    lpos: <T = number | null>(key: string, element: string, options?: {
+        RANK?: number;
+        COUNT?: number;
+        MAXLEN?: number;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    linsert: <T = number>(key: string, position: 'BEFORE' | 'AFTER', pivot: string, element: string, cb?: Callback<T>) => Promise<T>;
+    lmove: <T = string | null>(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb?: Callback<T>) => Promise<T>;
+    rpoplpush: <T = string | null>(source: string, destination: string, cb?: Callback<T>) => Promise<T>;
+    lmpop: <T = {
+        key: string;
+        elements: string[];
+    } | null>(keys: string | string[], side: 'LEFT' | 'RIGHT', options?: {
+        COUNT?: number;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
     sadd: <T = number>(key: string, members: string | string[], cb?: Callback<T>) => Promise<T>;
     srem: <T = number>(key: string, members: string | string[], cb?: Callback<T>) => Promise<T>;
     smembers: <T = string[]>(key: string, cb?: Callback<T>) => Promise<T>;
-    sismember: <T = number>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
+    sismember: <T = boolean>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
+    smismember: <T = boolean[]>(key: string, members: string | string[], cb?: Callback<T>) => Promise<T>;
     scard: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
     spop: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
-    srandmember: <T = string | string[] | null>(key: string, count?: number | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    smove: <T = boolean>(source: string, destination: string, member: string, cb?: Callback<T>) => Promise<T>;
+    srandmember: <T = string | null>(key: string, count?: number | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    sinter: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sunion: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sdiff: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sintercard: <T = number>(keys: string | string[], options?: {
+        LIMIT?: number;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    sinterstore: <T = number>(destination: string, keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sunionstore: <T = number>(destination: string, keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sdiffstore: <T = number>(destination: string, keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    sscan: <T = ScanReply>(key: string, cursor: string | number, options?: ScanOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
     zadd: <T = number>(key: string, score: number, member: string, options?: ZAddOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
-    zrange: <T = string[]>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
-    zrangeWithScores: <T = string[]>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
+    zrange: <T = string[]>(key: string, start: number | string, stop: number | string, cb?: Callback<T>) => Promise<T>;
+    zrangeWithScores: <T = ScoredMember[]>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
+    zrangebyscore: <T = string[]>(key: string, min: number | string, max: number | string, cb?: Callback<T>) => Promise<T>;
+    zrangestore: <T = number>(destination: string, source: string, min: number | string, max: number | string, cb?: Callback<T>) => Promise<T>;
     zrem: <T = number>(key: string, members: string | string[], cb?: Callback<T>) => Promise<T>;
-    zscore: <T = string | null>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
+    zscore: <T = number | null>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
+    zmscore: <T = (number | null)[]>(key: string, members: string | string[], cb?: Callback<T>) => Promise<T>;
     zrank: <T = number | null>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
+    zrevrank: <T = number | null>(key: string, member: string, cb?: Callback<T>) => Promise<T>;
     zcard: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
-    zincrby: <T = string>(key: string, increment: number, member: string, cb?: Callback<T>) => Promise<T>;
+    zcount: <T = number>(key: string, min: number | string, max: number | string, cb?: Callback<T>) => Promise<T>;
+    zlexcount: <T = number>(key: string, min: string, max: string, cb?: Callback<T>) => Promise<T>;
+    zincrby: <T = number>(key: string, increment: number, member: string, cb?: Callback<T>) => Promise<T>;
+    zpopmin: <T = ScoredMember | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    zpopmax: <T = ScoredMember | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    zrandmember: <T = string | null>(key: string, cb?: Callback<T>) => Promise<T>;
+    zdiff: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    zinter: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    zunion: <T = string[]>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    zintercard: <T = number>(keys: string | string[], options?: {
+        LIMIT?: number;
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    zremrangebyrank: <T = number>(key: string, start: number, stop: number, cb?: Callback<T>) => Promise<T>;
+    zremrangebyscore: <T = number>(key: string, min: number | string, max: number | string, cb?: Callback<T>) => Promise<T>;
+    zremrangebylex: <T = number>(key: string, min: string, max: string, cb?: Callback<T>) => Promise<T>;
+    zscan: <T = ScanReply>(key: string, cursor: string | number, options?: ScanOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    setbit: <T = number>(key: string, offset: number, value: 0 | 1, cb?: Callback<T>) => Promise<T>;
+    getbit: <T = number>(key: string, offset: number, cb?: Callback<T>) => Promise<T>;
+    bitcount: <T = number>(key: string, options?: {
+        start?: number;
+        end?: number;
+        mode?: 'BYTE' | 'BIT';
+    } | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    bitpos: <T = number>(key: string, bit: 0 | 1, options?: Record<string, any> | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    bitop: <T = number>(operation: 'AND' | 'OR' | 'XOR' | 'NOT', destination: string, keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    pfadd: <T = boolean>(key: string, elements: string | string[], cb?: Callback<T>) => Promise<T>;
+    pfcount: <T = number>(keys: string | string[], cb?: Callback<T>) => Promise<T>;
+    pfmerge: <T = string>(destination: string, sources: string | string[], cb?: Callback<T>) => Promise<T>;
+    xadd: <T = string>(key: string, id: string, message: Record<string, string>, cb?: Callback<T>) => Promise<T>;
+    xlen: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
+    xrange: <T = any[]>(key: string, start: string, end: string, cb?: Callback<T>) => Promise<T>;
+    xrevrange: <T = any[]>(key: string, end: string, start: string, cb?: Callback<T>) => Promise<T>;
+    xdel: <T = number>(key: string, ids: string | string[], cb?: Callback<T>) => Promise<T>;
+    xtrim: <T = number>(key: string, strategy: 'MAXLEN' | 'MINID', threshold: number | string, cb?: Callback<T>) => Promise<T>;
+    xack: <T = number>(key: string, group: string, ids: string | string[], cb?: Callback<T>) => Promise<T>;
+    eval: <T = any>(script: string, options?: {
+        keys?: string[];
+        arguments?: string[];
+    }, cb?: Callback<T>) => Promise<T>;
+    evalsha: <T = any>(sha: string, options?: {
+        keys?: string[];
+        arguments?: string[];
+    }, cb?: Callback<T>) => Promise<T>;
+    scriptLoad: <T = string>(script: string, cb?: Callback<T>) => Promise<T>;
+    fcall: <T = any>(fn: string, options?: {
+        keys?: string[];
+        arguments?: string[];
+    }, cb?: Callback<T>) => Promise<T>;
+    fcallRo: <T = any>(fn: string, options?: {
+        keys?: string[];
+        arguments?: string[];
+    }, cb?: Callback<T>) => Promise<T>;
+    publish: <T = number>(channel: string, message: string, cb?: Callback<T>) => Promise<T>;
+    spublish: <T = number>(channel: string, message: string, cb?: Callback<T>) => Promise<T>;
+    subscribe: <T = true>(channels: string | string[], options?: SubscribeOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
+    unsubscribe: <T = true>(channels: string | string[], options?: SubscribeOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
     multi: <T = any[]>(commands: {
         command: string;
-        args: any[];
+        args?: any[];
     }[], cb?: Callback<T>) => Promise<T>;
-    keys: <T = string[]>(pattern: string, cb?: Callback<T>) => Promise<T>;
-    scan: <T = [string, string[]]>(cursor: number, options?: ScanOptions | Callback<T>, cb?: Callback<T>) => Promise<T>;
-    type: <T = string>(key: string, cb?: Callback<T>) => Promise<T>;
-    rename: <T = string>(key: string, newKey: string, cb?: Callback<T>) => Promise<T>;
-    persist: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
-    pttl: <T = number>(key: string, cb?: Callback<T>) => Promise<T>;
-    expireat: <T = number>(key: string, timestamp: number, cb?: Callback<T>) => Promise<T>;
     ping: <T = string>(cb?: Callback<T>) => Promise<T>;
-    flushdb: <T = string>(cb?: Callback<T>) => Promise<T>;
+    time: <T = any>(cb?: Callback<T>) => Promise<T>;
     dbsize: <T = number>(cb?: Callback<T>) => Promise<T>;
-    raw: <T = any>(command: string, args: any[], cb?: Callback<T>) => Promise<T>;
+    flushdb: <T = string>(cb?: Callback<T>) => Promise<T>;
+    flushall: <T = string>(cb?: Callback<T>) => Promise<T>;
+    info: <T = string>(section?: string, cb?: Callback<T>) => Promise<T>;
+    configGet: <T = Record<string, string>>(parameter: string, cb?: Callback<T>) => Promise<T>;
+    raw: <T = any>(command: string, args?: any[], cb?: Callback<T>) => Promise<T>;
 }
 export declare const redisfx: RedisFX;
 export {};