From 736ff290b8780f76fb0f01ede0c9b704bb8bc3a1 Mon Sep 17 00:00:00 2001 From: Casper Beyer Date: Wed, 19 May 2021 21:07:10 +0800 Subject: docs(cli/dts): fix plugin example (#10647) --- cli/dts/lib.deno.unstable.d.ts | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) (limited to 'cli/dts/lib.deno.unstable.d.ts') 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. -- cgit v1.2.3