summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/substr.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/substr.md')
-rw-r--r--iredis/data/commands/substr.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/iredis/data/commands/substr.md b/iredis/data/commands/substr.md
new file mode 100644
index 0000000..7283def
--- /dev/null
+++ b/iredis/data/commands/substr.md
@@ -0,0 +1,22 @@
+Returns the substring of the string value stored at `key`, determined by the
+offsets `start` and `end` (both are inclusive).
+Negative offsets can be used in order to provide an offset starting from the end
+of the string.
+So -1 means the last character, -2 the penultimate and so forth.
+
+The function handles out of range requests by limiting the resulting range to
+the actual length of the string.
+
+@return
+
+@bulk-string-reply
+
+@examples
+
+```cli
+SET mykey "This is a string"
+GETRANGE mykey 0 3
+GETRANGE mykey -3 -1
+GETRANGE mykey 0 -1
+GETRANGE mykey 10 100
+```