@upstash/redis 1.40.0 → 1.41.0

package/docs/commands/list/lindex.mdx

@@ -0,0 +1,32 @@
+---
+title: LINDEX
+description: Returns the element at index index in the list stored at key.
+---
+
+The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list.
+
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the list.
+</ParamField>
+
+<ParamField body="index" type="number" required>
+    The index of the element to return, zero-based.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="TValue | null" required>
+  The value of the element at index index in the list. If the index is out of range, `null` is returned.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.rpush("key", "a", "b", "c");
+const element = await redis.lindex("key", 0);
+console.log(element); // "a"
+```
+</RequestExample>

package/docs/commands/list/linsert.mdx

@@ -0,0 +1,41 @@
+---
+title: LINSERT
+description: Insert an element before or after another element in a list
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the list.
+</ParamField>
+
+
+
+<ParamField body="direction" type="before | after" required>
+    Whether to insert the element before or after pivot.
+</ParamField>
+
+
+
+<ParamField body="pivot" type="TValue" required>
+    The element to insert before or after.
+</ParamField>
+
+
+
+<ParamField body="value" type="TValue" required>
+    The element to insert.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+The list length after insertion, `0` when the list doesn't exist or `-1` when pivot was not found.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.rpush("key", "a", "b", "c");
+await redis.linsert("key", "before", "b", "x");
+```
+</RequestExample>

package/docs/commands/list/llen.mdx

@@ -0,0 +1,26 @@
+---
+title: LLEN
+description: Returns the length of the list stored at key.
+---
+
+
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the list.
+</ParamField>
+
+## Response
+
+<ResponseField type="number" required>
+    The length of the list at key.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.rpush("key", "a", "b", "c");
+const length = await redis.llen("key");
+console.log(length); // 3
+```
+</RequestExample>

package/docs/commands/list/lmove.mdx

@@ -0,0 +1,34 @@
+---
+title: LMOVE
+description: Move an element from one list to another.
+---
+
+## Arguments
+
+<ParamField body="source" type="string" required>
+  The key of the source list.
+</ParamField>
+
+<ParamField body="destination" type="string" required>
+  The key of the destination list.
+</ParamField>
+
+<ParamField body="from" type='"left" | "right"' required>
+  The side of the source list from which the element was popped.
+</ParamField>
+
+<ParamField body="to" type='"left" | "right"' required>
+  The side of the destination list to which the element was pushed.
+</ParamField>
+
+## Response
+<ResponseField type="TValue" required>
+  The element that was moved.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+ await redis.rpush("source", "a", "b", "c"); 
+ const element = await redis.move("source", "destination", "left", "left");  
+```
+</RequestExample>

package/docs/commands/list/lpop.mdx

@@ -0,0 +1,37 @@
+---
+title: LPOP
+description: Remove and return the first element(s) of a list
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="count" type="integer">
+  How many elements to pop. If not specified, a single element is popped.
+</ParamField>
+
+## Response
+
+<ResponseField type="TValue | TValue[] | null" required>
+  The popped element(s). If `count` was specified, an array of elements is
+  returned, otherwise a single element is returned. If the list is empty, `null`
+  is returned.
+</ResponseField>
+
+<RequestExample>
+```ts Single 
+await redis.rpush("key", "a", "b", "c"); 
+const element = await redis.lpop("key");
+console.log(element); // "a"
+ ```
+
+
+```ts Multiple 
+await redis.rpush("key", "a", "b", "c"); 
+const element = await redis.lpop("key", 2);
+console.log(element); // ["a", "b"]
+ ```
+</RequestExample>

package/docs/commands/list/lpos.mdx

@@ -0,0 +1,56 @@
+---
+title: LPOS
+description: Returns the index of matching elements inside a list.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="element" type="unknown" required>
+  The element to match.
+</ParamField>
+
+<ParamField body="opts">
+  <ParamField body="rank" type="number">
+    The rank of the element to match. If specified, the element at the given
+    rank is matched instead of the first element.
+  </ParamField>
+  <ParamField body="count" type="number">
+    The maximum number of elements to match. If specified, an array of elements
+    is returned instead of a single element.
+  </ParamField>
+  <ParamField body="maxLen" type="number">
+    Limit the number of comparisons to perform.
+  </ParamField>
+</ParamField>
+
+## Response
+
+<ResponseField type="number | number[]" required>
+  The index of the matching element or an array of indexes if `opts.count` is
+  specified.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.rpush("key", "a", "b", "c"); 
+const index = await redis.lpos("key", "b");
+console.log(index); // 1
+ ```
+
+```ts With Rank 
+await redis.rpush("key", "a", "b", "c", "b"); 
+const index = await redis.lpos("key", "b", { rank: 2 });
+console.log(index); // 3
+ ```
+
+```ts With Count
+await redis.rpush("key", "a", "b", "b");
+const positions = await redis.lpos("key", "b", { count: 2 });
+console.log(positions); // [1, 2]
+```
+
+</RequestExample>

package/docs/commands/list/lpush.mdx

@@ -0,0 +1,32 @@
+---
+title: LPUSH
+description: Push an element at the head of the list.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="elements" type="...TValue[]" required>
+  One or more elements to push at the head of the list.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  The length of the list after the push operation.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+const length1 = await redis.lpush("key", "a", "b", "c"); 
+console.log(length1); // 3
+const length2 = await redis.lpush("key", "d"); 
+console.log(length2); // 4
+ ```
+
+
+</RequestExample>

package/docs/commands/list/lpushx.mdx

@@ -0,0 +1,38 @@
+---
+title: LPUSHX
+description: Push an element at the head of the list only if the list exists.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="elements" type="...TValue[]" required>
+  One or more elements to push at the head of the list.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  The length of the list after the push operation.
+
+  `0` if the list did not exist and thus no element was pushed.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "b", "c"); 
+const length = await redis.lpushx("key", "d"); 
+console.log(length); // 4
+ ```
+
+ ```ts Without existing list 
+const length = await redis.lpushx("key", "a"); 
+console.log(length); // 0
+ ```
+
+
+</RequestExample>

package/docs/commands/list/lrange.mdx

@@ -0,0 +1,37 @@
+---
+title: LRANGE
+description: Returns the specified elements of the list stored at key.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="start" type="integer" required>
+  The starting index of the range to return.
+
+  Use negative numbers to specify offsets starting at the end of the list.
+</ParamField>
+
+
+<ParamField body="end" type="integer" required>
+  The ending index of the range to return.
+
+  Use negative numbers to specify offsets starting at the end of the list.
+</ParamField>
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The list of elements in the specified range.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "b", "c"); 
+const elements = await redis.lrange("key", 1, 2); 
+console.log(elements) // ["b", "c"]
+ ```
+</RequestExample>

package/docs/commands/list/lrem.mdx

@@ -0,0 +1,33 @@
+---
+title: LREM
+description: Remove the first `count` occurrences of an element from a list.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="count" type="number" required>
+ How many occurrences of the element to remove.
+</ParamField>
+
+
+<ParamField body="element" type="TValue" required>
+ The element to remove
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+  The number of elements removed.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "a", "b", "b", "c"); 
+const removed = await redis.lrem("key", 4, "b"); 
+console.log(removed) // 2
+ ```
+</RequestExample>

package/docs/commands/list/lset.mdx

@@ -0,0 +1,34 @@
+---
+title: LSET
+description: Set a value at a specific index.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="index" type="number" required>
+ At which index to set the value.
+</ParamField>
+
+
+<ParamField body="data" type="TValue" required>
+  The value to set.
+</ParamField>
+
+## Response
+
+<ResponseField type="OK" required>
+  `OK`
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "b", "c"); 
+await redis.lset("key", 1, "d"); 
+
+// list is now ["a", "d", "c"]
+ ```
+</RequestExample>

package/docs/commands/list/ltrim.mdx

@@ -0,0 +1,33 @@
+---
+title: LTRIM
+description: Trim a list to the specified range
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="start" type="number" required>
+  The index of the first element to keep.
+</ParamField>
+
+
+<ParamField body="end" type="TValue" required>
+  The index of the first element to keep.
+</ParamField>
+
+## Response
+
+<ResponseField type="OK" required>
+  `OK`
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "b", "c", "d"); 
+await redis.ltrim("key", 1, 2); 
+// the list is now ["b", "c"]
+ ```
+</RequestExample>

package/docs/commands/list/rpop.mdx

@@ -0,0 +1,37 @@
+---
+title: RPOP
+description: Remove and return the last element(s) of a list
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="count" type="integer">
+  How many elements to pop. If not specified, a single element is popped.
+</ParamField>
+
+## Response
+
+<ResponseField type="TValue | TValue[] | null" required>
+  The popped element(s). If `count` was specified, an array of elements is
+  returned, otherwise a single element is returned. If the list is empty, `null`
+  is returned.
+</ResponseField>
+
+<RequestExample>
+```ts Single 
+await redis.rpush("key", "a", "b", "c"); 
+const element = await redis.rpop("key");
+console.log(element); // "c"
+ ```
+
+
+```ts Multiple 
+await redis.rpush("key", "a", "b", "c"); 
+const element = await redis.rpop("key", 2);
+console.log(element); // ["c", "b"]
+ ```
+</RequestExample>

package/docs/commands/list/rpush.mdx

@@ -0,0 +1,32 @@
+---
+title: RPUSH
+description: Push an element at the end of the list.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="elements" type="...TValue[]" required>
+  One or more elements to push at the end of the list.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  The length of the list after the push operation.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+const length1 = await redis.rpush("key", "a", "b", "c"); 
+console.log(length1); // 3
+const length2 = await redis.rpush("key", "d"); 
+console.log(length2); // 4
+ ```
+
+
+</RequestExample>

package/docs/commands/list/rpushx.mdx

@@ -0,0 +1,38 @@
+---
+title: RPUSHX
+description: Push an element at the end of the list only if the list exists.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the list.
+</ParamField>
+
+<ParamField body="elements" type="...TValue[]" required>
+  One or more elements to push at the end of the list.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  The length of the list after the push operation.
+
+  `0` if the list did not exist and thus no element was pushed.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.lpush("key", "a", "b", "c"); 
+const length = await redis.rpushx("key", "d"); 
+console.log(length); // 4
+ ```
+
+ ```ts Without existing list 
+const length = await redis.rpushx("key", "a"); 
+console.log(length); // 0
+ ```
+
+
+</RequestExample>