summaryrefslogtreecommitdiff
path: root/cli/dts/lib.deno.unstable.d.ts
diff options
context:
space:
mode:
authorCasper Beyer <caspervonb@pm.me>2021-05-19 21:07:10 +0800
committerGitHub <noreply@github.com>2021-05-19 15:07:10 +0200
commit8a9b83b3ea782c73942df72b5cada2302fb1b8c3 (patch)
tree386af4eb7bc1a47ee3ebbe30af8133806128879a /cli/dts/lib.deno.unstable.d.ts
parentb43b639f450ad31fdf3c054b6d4718d4ba29a6a7 (diff)
docs(cli/dts): fix plugin example (#10647)
Diffstat (limited to 'cli/dts/lib.deno.unstable.d.ts')
-rw-r--r--cli/dts/lib.deno.unstable.d.ts21
1 files changed, 18 insertions, 3 deletions
diff --git a/cli/dts/lib.deno.unstable.d.ts b/cli/dts/lib.deno.unstable.d.ts
index b64117c23..480b0ee06 100644
--- a/cli/dts/lib.deno.unstable.d.ts
+++ b/cli/dts/lib.deno.unstable.d.ts
@@ -133,10 +133,25 @@ declare namespace Deno {
* Open and initialize a plugin.
*
* ```ts
+ * import { assert } from "https://deno.land/std/testing/asserts.ts";
* const rid = Deno.openPlugin("./path/to/some/plugin.so");
- * const opId = Deno.core.ops()["some_op"];
- * const response = Deno.core.dispatch(opId, new Uint8Array([1,2,3,4]));
- * console.log(`Response from plugin ${response}`);
+ *
+ * // The Deno.core namespace is needed to interact with plugins, but this is
+ * // internal so we use ts-ignore to skip type checking these calls.
+ * // @ts-ignore
+ * const {
+ * op_test_sync,
+ * op_test_async,
+ * } = Deno.core.ops();
+ *
+ * assert(op_test_sync);
+ * assert(op_test_async);
+ *
+ * // @ts-ignore
+ * const result = Deno.core.opSync("op_test_sync");
+ *
+ * // @ts-ignore
+ * const result = await Deno.core.opAsync("op_test_sync");
* ```
*
* Requires `allow-plugin` permission.