Class GlideClient

Example

const len = await client.append("key", "Hello");
console.log(len);
// Output: 5
// Indicates that "Hello" has been appended to the value of "key", which was initially
// empty, resulting in a new value of "Hello" with a length of 5 - similar to the set operation.

len = await client.append("key", " world");
console.log(result);
// Output: 11
// Indicates that " world" has been appended to the value of "key", resulting in a
// new value of "Hello world" with a length of 11.
Copy

Example

console.log(await client.bitcount("my_key1"));
// Output: 2
// The string stored at `my_key1` contains 2 set bits.

console.log(await client.bitcount("my_key2", { start: 1 }));
// Output: 8
// From the second to to the last bytes of the string stored at `my_key2` are contain 8 set bits.

console.log(await client.bitcount("my_key2", { start: 1, end: 3 }));
// Output: 2
// The second to fourth bytes of the string stored at `my_key2` contain 2 set bits.

console.log(await client.bitcount("my_key3", { start: 1, end: 1, indexType: BitmapIndexType.BIT }));
// Output: 1
// Indicates that the second bit of the string stored at `my_key3` is set.

console.log(await client.bitcount("my_key3", { start: -1, end: -1, indexType: BitmapIndexType.BIT }));
// Output: 1
// Indicates that the last bit of the string stored at `my_key3` is set.
Copy

Example

await client.set("key", "A");  // "A" has binary value 01000001
const result = await client.bitfield("key", [new BitFieldSet(new UnsignedEncoding(2), new BitOffset(1), 3), new BitFieldGet(new UnsignedEncoding(2), new BitOffset(1))]);
console.log(result);
// Output: [2, 3]
// The old value at offset 1 with an unsigned encoding of 2 was 2. The new value at offset 1 with an unsigned encoding of 2 is 3.
Copy

Example

await client.set("key", "A");  // "A" has binary value 01000001
const result = await client.bitfieldReadOnly("key", [new BitFieldGet(new UnsignedEncoding(2), new BitOffset(1))]);
console.log(result);
// Output: [2]
// The value at offset 1 with an unsigned encoding of 2 is 2.
Copy

Example

await client.set("key1", "A"); // "A" has binary value 01000001
await client.set("key2", "B"); // "B" has binary value 01000010
const result1 = await client.bitop(BitwiseOperation.AND, "destination", ["key1", "key2"]);
console.log(result1);
// Output: 1
// The size of the resulting string stored in "destination" is 1.

const result2 = await client.get("destination");
console.log(result2);
// Output: "@"
// "@" has binary value 01000000
Copy

Example

await client.set("key1", "A1");  // "A1" has binary value 01000001 00110001
const result1 = await client.bitpos("key1", 1);
console.log(result1);
// Output: 1
// The first occurrence of bit value 1 in the string stored at `key1` is at the second position.

const result2 = await client.bitpos("key1", 1, { start: -1 });
console.log(result2);
// Output: 10
// The first occurrence of bit value 1, starting at the last byte in the string stored at `key1`, is at the eleventh position.

await client.set("key1", "A12");  // "A12" has binary value 01000001 00110001 00110010
const result3 = await client.bitpos("key1", 1, { start: 1, end: -1 });
console.log(result3);
// Output: 10
// The first occurrence of bit value 1 in the second byte to the last byte of the string stored at `key1` is at the eleventh position.

const result4 = await client.bitpos("key1", 1, { start: 2, end: 9, indexType: BitmapIndexType.BIT });
console.log(result4);
// Output: 7
// The first occurrence of bit value 1 in the third to tenth bits of the string stored at `key1` is at the eighth position.
Copy

Example

await client.lpush("testKey1", ["two", "one"]); // The key `testKey1` has a list ["one", "two"] after this operation.
await client.lpush("testKey2", ["four", "three"]); // The key `testKey2` has a list ["three", "four"] after this operation.
const result = await client.blmove("testKey1", "testKey2", ListDirection.LEFT, ListDirection.LEFT, 0.1);
console.log(result);
// Output: "one"
// Removes "one" from the list at key `testKey1` and adds it to the left of the list at `testKey2`.

const updated_array1 = await client.lrange("testKey1", 0, -1);
console.log(updated_array1);
// Output: "two"
// The elements in the list at `testKey1` after blmove command.

const updated_array2 = await client.lrange("testKey2", 0, -1);
console.log(updated_array2);
// Output: ["one", "three", "four"]
// The elements in the list at `testKey2` after blmove command.
Copy

Example

await client.lpush("testKey", ["one", "two", "three"]);
await client.lpush("testKey2", ["five", "six", "seven"]);
const result = await client.blmpop(["testKey", "testKey2"], ListDirection.LEFT, 0.1, 1);
console.log(result"testKey");
// Output: { key: "testKey", elements: ["three"] }
Copy

Example

const result = await client.blpop(["list1", "list2"], 5);
console.log(result);
// Output: ['list1', 'element']
// An element `element` popped from the list stored at key `list1`.
Copy

Example

// Example usage of brpop method to block and wait for elements from multiple lists
const result = await client.brpop(["list1", "list2"], 5);
console.log(result);
// Output: ["list1", "element"]
// Indicates an element `element` was popped from `list1`.
Copy

Example

await client.zadd("zSet1", { one: 1.0, two: 2.0, three: 3.0 });
await client.zadd("zSet2", { four: 4.0 });
console.log(await client.bzmpop(["zSet1", "zSet2"], ScoreFilter.MAX, 0.1, 2));
// Output:
// [ "zSet1", [
//     { element: 'three', score: 3 },
//     { element: 'two', score: 2 }
// ] ]
// `three` with score 3 and `two` with score 2 were popped from `zSet1`
Copy

Example

const data = await client.bzpopmax(["zset1", "zset2"], 0.5);
console.log(data);
// Output: ["zset1", "c", 2];
Copy

Example

const data = await client.bzpopmin(["zset1", "zset2"], 0.5);
console.log(data);
// Output: ["zset1", "a", 2];
// Pops the member `a` with score 2 stored at key `zset1`.
Copy

Example

const result = await client.copy("set1", "set2");
console.log(result); // Output: true - "set1" was copied to "set2".
Copy

const result = await client.copy("set1", "set2", { replace: true });
console.log(result); // Output: true - "set1" was copied to "set2".
Copy

const result = await client.copy("set1", "set2", { destinationDB: 1, replace: false });
console.log(result); // Output: true - "set1" was copied to "set2".
Copy

Example

// Example usage of decr method to decrement the value of a key by 1
await client.set("my_counter", "10");
const result = await client.decr("my_counter");
console.log(result); // Output: 9
Copy

Example

// Example usage of decrby method to decrement the value of a key by a specified amount
await client.set("my_counter", "10");
const result = await client.decrby("my_counter", 5);
console.log(result); // Output: 5
Copy

Example

// Example usage of del method to delete an existing key
await client.set("my_key", "my_value");
const result = await client.del(["my_key"]);
console.log(result); // Output: 1
Copy

Example

// Example usage of del method for a non-existing key
const result = await client.del(["non_existing_key"]);
console.log(result); // Output: 0
Copy

Example

let result = await client.dump("myKey");
console.log(result);
// Result contains the serialized value of `myKey`
Copy

Example

result = await client.dump("nonExistingKey");
console.log(result);
// Output: null
Copy

Example

// Example usage of the exists method
const result = await client.exists(["key1", "key2", "key3"]);
console.log(result);
// Output: 3
// Indicates that all three keys exist in the database.
Copy

Example

// Example usage of the expire method
const result = await client.expire("my_key", 60);
console.log(result);
// Output: true
// Indicates that a timeout of 60 seconds has been set for `my_key`.
Copy

Example

// Example usage of the expire method with exisiting expiry
const result = await client.expire("my_key", 60, { expireOption: ExpireOptions.HasNoExpiry });
console.log(result);
// Output: false
// Indicates that `my_key` has an existing expiry.
Copy

Example

// Example usage of the expireAt method on a key with no previous expiry
const result = await client.expireAt("my_key", 1672531200, { expireOption: ExpireOptions.HasNoExpiry });
console.log(result);
// Output: true
// Indicates that the expiration time for `my_key` was successfully set.
Copy

Example

const result1 = await client.expiretime("myKey");
console.log(result1);
// Output: -2
// `myKey` doesn't exist.

const result2 = await client.set("myKey", "value");
const result3 = await client.expireTime("myKey");
console.log(result3);
// Output: -1
// `myKey` has no associated expiration.

client.expire(myKey, 60);
const result3 = await client.expireTime("myKey");
console.log(result3);
// Output: 123456
// The Unix timestamp (in seconds) when `myKey` will expire.
Copy

Example

const response = await client.fcall("Deep_Thought", [], []);
console.log(response); // Returns the function's return value.
Copy

Example

const response = await client.fcallReadOnly("Deep_Thought", ["key1"], ["Answer", "to", "the",
           "Ultimate", "Question", "of", "Life,", "the", "Universe,", "and", "Everything"]);
console.log(response);
// Output: 42
// The return value on the function that was executed.
Copy

Example

const options = {updateMode: ConditionalChange.ONLY_IF_EXISTS, changed: true};
const membersToCoordinates = new Map<string, GeospatialData>([
     ["Palermo", { longitude: 13.361389, latitude: 38.115556 }],
]);
const num = await client.geoadd("mySortedSet", membersToCoordinates, options);
console.log(num);
// Output: 1
// Indicates that the position of an existing member in the sorted set `mySortedSet` has been updated.
Copy