DOC-3933: final 8 tabbed code examples (#2784)

Author: dwdougherty

doctests/dt-bitfield.js

@@ -0,0 +1,76 @@
+// EXAMPLE: bitfield_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bf
+let res1 = await client.bitField("bike:1:stats", [{
+  operation: 'SET',
+  encoding: 'u32',
+  offset: '#0',
+  value: 1000
+}]);
+console.log(res1);  // >>> [0]
+
+let res2 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#0',
+    increment: -50
+  },
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#1',
+    increment: 1
+  }
+]);
+console.log(res2);  // >>> [950, 1]
+
+let res3 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#0',
+    increment: 500
+  },
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#1',
+    increment: 1
+  }
+]);
+console.log(res3);  // >>> [1450, 2]
+
+let res4 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'GET',
+    encoding: 'u32',
+    offset: '#0'
+  },
+  {
+    operation: 'GET',
+    encoding: 'u32',
+    offset: '#1'
+  }
+]);
+console.log(res4);  // >>> [1450, 2]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res1, [0])
+assert.deepEqual(res2, [950, 1])
+assert.deepEqual(res3, [1450, 2])
+assert.deepEqual(res4, [1450, 2])
+await client.quit();
+// REMOVE_END

doctests/dt-bloom.js

@@ -0,0 +1,46 @@
+// EXAMPLE: bf_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bloom
+const res1 = await client.bf.reserve('bikes:models', 0.01, 1000);
+console.log(res1);  // >>> OK
+
+const res2 = await client.bf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2);  // >>> true
+
+const res3 = await client.bf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3);  // >>> true
+
+const res4 = await client.bf.mAdd('bikes:models', [
+  'Rocky Mountain Racer',
+  'Cloudy City Cruiser',
+  'Windy City Wippet'
+]);
+console.log(res4);  // >>> [true, true, true]
+
+const res5 = await client.bf.mExists('bikes:models', [
+  'Rocky Mountain Racer',
+  'Cloudy City Cruiser',
+  'Windy City Wippet'
+]);
+console.log(res5);  // >>> [true, true, true]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.deepEqual(res4, [true, true, true])
+assert.deepEqual(res5, [true, true, true])
+await client.quit();
+// REMOVE_END

doctests/dt-cms.js

@@ -0,0 +1,50 @@
+// EXAMPLE: cms_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cms
+const res1 = await client.cms.initByProb('bikes:profit', 0.001, 0.002);
+console.log(res1);  // >>> OK
+
+const res2 = await client.cms.incrBy('bikes:profit', {
+    item: 'Smoky Mountain Striker',
+    incrementBy: 100
+});
+console.log(res2);  // >>> [100]
+
+const res3 = await client.cms.incrBy('bikes:profit', [
+  {
+    item: 'Rocky Mountain Racer',
+    incrementBy: 200
+  },
+  {
+    item: 'Cloudy City Cruiser',
+    incrementBy: 150
+  }
+]);
+console.log(res3);  // >>> [200, 150]
+
+const res4 = await client.cms.query('bikes:profit', 'Smoky Mountain Striker');
+console.log(res4);  // >>> [100]
+
+const res5 = await client.cms.info('bikes:profit');
+console.log(res5.width, res5.depth, res5.count);  // >>> 2000 9 450
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.deepEqual(res2, [100])
+assert.deepEqual(res3, [200, 150])
+assert.deepEqual(res4, [100])
+assert.deepEqual(res5, { width: 2000, depth: 9, count: 450 })
+await client.quit();
+// REMOVE_END

doctests/dt-cuckoo.js

@@ -0,0 +1,38 @@
+// EXAMPLE: cuckoo_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cuckoo
+const res1 = await client.cf.reserve('bikes:models', 1000000);
+console.log(res1);  // >>> OK
+
+const res2 = await client.cf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2);  // >>> 1
+
+const res3 = await client.cf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3);  // >>> 1
+
+const res4 = await client.cf.exists('bikes:models', 'Terrible Bike Name');
+console.log(res4);  // >>> 0
+
+const res5 = await client.cf.del('bikes:models', 'Smoky Mountain Striker');
+console.log(res5);  // >>> 1
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.equal(res4, false)
+assert.equal(res5, true)
+await client.quit();
+// REMOVE_END

doctests/dt-hll.js

@@ -0,0 +1,38 @@
+// EXAMPLE: hll_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START pfadd
+const res1 = await client.pfAdd('bikes', ['Hyperion', 'Deimos', 'Phoebe', 'Quaoar']);
+console.log(res1);  // >>> true
+
+const res2 = await client.pfCount('bikes');
+console.log(res2);  // >>> 4
+
+const res3 = await client.pfAdd('commuter_bikes', ['Salacia', 'Mimas', 'Quaoar']);
+console.log(res3);  // >>> true
+
+const res4 = await client.pfMerge('all_bikes', ['bikes', 'commuter_bikes']);
+console.log(res4);  // >>> OK
+
+const res5 = await client.pfCount('all_bikes');
+console.log(res5);  // >>> 6
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, true)
+assert.equal(res2, 4)
+assert.equal(res3, true)
+assert.equal(res4, 'OK')
+assert.equal(res5, 6)
+await client.quit();
+// REMOVE_END