Merge pull request #238 from vim-denops/lambda-add

👍 Add `lambda.add()` to add a lambda function and return a Lambda object

Author: lambdalisue

lambda/mod.ts

@@ -10,21 +10,21 @@
  *
  * export async function main(denops: Denops): Promise<void> {
  *   // Add lambda function
- *   const id = lambda.register(
+ *   const lo = lambda.add(
  *     denops,
  *     () => {
  *       // Do what ever you want.
  *     },
  *   );
  *
  *   // Use id to dispatch added function from Deno
- *   await denops.dispatch(denops.name, id);
+ *   await denops.dispatch(denops.name, lo.id);
  *
  *   // Or from Vim
- *   await denops.cmd("call denops#notify(name, id, [])", {
- *     name: denops.name,
- *     id,
- *   });
+ *   await denops.cmd(`call ${lo.notify()}`);
+ *
+ *   // Dispose the lambda object
+ *   lo.dispose();
  * }
  * ```
  *
@@ -142,3 +142,103 @@ export function unregister(
   }
   return false;
 }
+
+export interface Lambda {
+  readonly id: Identifier;
+
+  /**
+   * Create a Vim script expression to notify the lambda function
+   *
+   * ```typescript
+   * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+   * import * as lambda from "https://deno.land/x/denops_std@$MODULE_VERSION/lambda/mod.ts";
+   *
+   * export async function main(denops: Denops): Promise<void> {
+   *   const a = lambda.add(denops, () => {
+   *     // Do what ever you want.
+   *   });
+   *   await denops.cmd(`nmap <Space> <Cmd>call ${a.notify()}<CR>`);
+   * }
+   * ```
+   */
+  notify(...args: unknown[]): string;
+
+  /**
+   * Create a Vim script expression to request the lambda function
+   *
+   * ```typescript
+   * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+   * import * as lambda from "https://deno.land/x/denops_std@$MODULE_VERSION/lambda/mod.ts";
+   *
+   * export async function main(denops: Denops): Promise<void> {
+   *   const a = lambda.add(denops, () => {
+   *     // Do what ever you want.
+   *   });
+   *   await denops.cmd(`nmap <Space> <Cmd>call ${a.request()}<CR>`);
+   * }
+   * ```
+   */
+  request(...args: unknown[]): string;
+
+  /**
+   * Dispose the lambda function
+   *
+   * ```typescript
+   * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+   * import * as lambda from "https://deno.land/x/denops_std@$MODULE_VERSION/lambda/mod.ts";
+   *
+   * export async function main(denops: Denops): Promise<void> {
+   *   const a = lambda.add(denops, () => {
+   *     // Do what ever you want.
+   *   });
+   *  // Dispose the lambda function manually
+   *  a.dispose();
+   * }
+   * ```
+   */
+  dispose(): void;
+
+  [Symbol.dispose](): void;
+}
+
+/**
+ * Add a lambda function to a denops API and return the lambda object
+ *
+ * ```typescript
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import * as lambda from "https://deno.land/x/denops_std@$MODULE_VERSION/lambda/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Add lambda function
+ *   const lo = lambda.add(
+ *     denops,
+ *     () => {
+ *       // Do what ever you want.
+ *     },
+ *   );
+ *
+ *   // Call the lambda function from Vim script
+ *   await denops.eval(lo.request());
+ *
+ *   // Dispose the lambda object
+ *   lo.dispose();
+ * }
+ * ```
+ */
+export function add(denops: Denops, fn: Fn): Lambda {
+  const id = register(denops, fn);
+  const name = denops.name;
+  return {
+    id,
+    notify: (...args: unknown[]) => {
+      args = args.map((v) => JSON.stringify(v));
+      return `denops#notify('${name}', '${id}', [${args}])`;
+    },
+    request: (...args: unknown[]) => {
+      args = args.map((v) => JSON.stringify(v));
+      return `denops#request('${name}', '${id}', [${args}])`;
+    },
+    dispose: () => unregister(denops, id),
+    [Symbol.dispose]: () => unregister(denops, id),
+  };
+}

lambda/mod_test.ts

@@ -61,5 +61,77 @@ test({
         );
       },
     });
+
+    await t.step({
+      name: "add() registers a lambda function and returns a Lambda object",
+      fn: async () => {
+        let counter = 0;
+        using lo = lambda.add(
+          denops,
+          () => {
+            counter++;
+            return counter;
+          },
+        );
+        assertEquals(
+          lo.request(),
+          `denops#request('${denops.name}', '${lo.id}', [])`,
+        );
+        assertEquals(
+          lo.notify(),
+          `denops#notify('${denops.name}', '${lo.id}', [])`,
+        );
+        assertEquals(await denops.eval(lo.request()), 1);
+        await denops.eval(lo.notify());
+        assertEquals(counter, 2);
+      },
+    });
+
+    await t.step({
+      name:
+        "add() registers a lambda function with arguments and returns a Lambda object",
+      fn: async () => {
+        using lo = lambda.add(
+          denops,
+          (a: unknown, b: unknown, c: unknown) => {
+            return [a, b, c];
+          },
+        );
+        assertEquals(
+          lo.request(1, "2", [3]),
+          `denops#request('${denops.name}', '${lo.id}', [1,"2",[3]])`,
+        );
+        assertEquals(
+          lo.notify(1, "2", [3]),
+          `denops#notify('${denops.name}', '${lo.id}', [1,"2",[3]])`,
+        );
+        assertEquals(await denops.eval(lo.request(1, "2", [3])), [1, "2", [3]]);
+      },
+    });
+
+    await t.step({
+      name: "add() return a disposable object",
+      fn: async () => {
+        // Unregister all methods
+        denops.dispatcher = {};
+        {
+          let counter = 0;
+          using lo = lambda.add(
+            denops,
+            () => {
+              counter++;
+              return counter;
+            },
+          );
+          assertEquals(await denops.eval(lo.request()), 1);
+          await denops.eval(lo.notify());
+          assertEquals(counter, 2);
+          // Still available
+          assertEquals(Object.keys(denops.dispatcher), [lo.id]);
+        }
+        // Unregistered automatically
+        assertEquals(Object.keys(denops.dispatcher), []);
+      },
+    });
   },
 });