Merge pull request #1 from nkaradzhov/update-docs

Update programmability examples

Author: bobymicroby

README.md

@@ -250,6 +250,10 @@ await Promise.all([
 ]);
 ```
 
+### Programmability
+
+See the [Programmability overview](./docs/programmability.md).
+
 ### Clustering
 
 Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.

docs/programmability.md

@@ -25,16 +25,22 @@ FUNCTION LOAD "#!lua name=library\nredis.register_function{function_name='add',
 Load the prior redis function on the _redis server_ before running the example below.
 
 ```typescript
-import { createClient } from 'redis';
+import { CommandParser } from '@redis/client/lib/client/parser';
+import { NumberReply } from '@redis/client/lib/RESP/types';
+import { createClient, RedisArgument } from 'redis';
 
 const client = createClient({
   functions: {
     library: {
       add: {
         NUMBER_OF_KEYS: 1,
-        FIRST_KEY_INDEX: 1,
-        transformArguments(key: string, toAdd: number): Array<string> {
-          return [key, toAdd.toString()];
+        parseCommand(
+          parser: CommandParser,
+          key: RedisArgument,
+          toAdd: RedisArgument
+        ) {
+          parser.pushKey(key)
+          parser.push(toAdd)
         },
         transformReply: undefined as unknown as () => NumberReply
       }
@@ -43,34 +49,39 @@ const client = createClient({
 });
 
 await client.connect();
-
 await client.set('key', '1');
-await client.library.add('key', 2); // 3
+await client.library.add('key', '2'); // 3
 ```
 
 ## [Lua Scripts](https://redis.io/docs/manual/programmability/eval-intro/)
 
 The following is an end-to-end example of the prior concept.
 
 ```typescript
-import { createClient, defineScript, NumberReply } from 'redis';
+import { CommandParser } from '@redis/client/lib/client/parser';
+import { NumberReply } from '@redis/client/lib/RESP/types';
+import { createClient, defineScript, RedisArgument } from 'redis';
 
 const client = createClient({
   scripts: {
     add: defineScript({
       SCRIPT: 'return redis.call("GET", KEYS[1]) + ARGV[1];',
       NUMBER_OF_KEYS: 1,
       FIRST_KEY_INDEX: 1,
-      transformArguments(key: string, toAdd: number): Array<string> {
-        return [key, toAdd.toString()];
+      parseCommand(
+        parser: CommandParser,
+        key: RedisArgument,
+        toAdd: RedisArgument
+      ) {
+        parser.pushKey(key)
+        parser.push(toAdd)
       },
       transformReply: undefined as unknown as () => NumberReply
     })
   }
 });
 
 await client.connect();
-
 await client.set('key', '1');
-await client.add('key', 2); // 3
+await client.add('key', '2'); // 3
 ```