summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/getbit.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/getbit.md')
-rw-r--r--iredis/data/commands/getbit.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/iredis/data/commands/getbit.md b/iredis/data/commands/getbit.md
new file mode 100644
index 0000000..2d05d12
--- /dev/null
+++ b/iredis/data/commands/getbit.md
@@ -0,0 +1,19 @@
+Returns the bit value at _offset_ in the string value stored at _key_.
+
+When _offset_ is beyond the string length, the string is assumed to be a
+contiguous space with 0 bits. When _key_ does not exist it is assumed to be an
+empty string, so _offset_ is always out of range and the value is also assumed
+to be a contiguous space with 0 bits.
+
+@return
+
+@integer-reply: the bit value stored at _offset_.
+
+@examples
+
+```cli
+SETBIT mykey 7 1
+GETBIT mykey 0
+GETBIT mykey 7
+GETBIT mykey 100
+```