docs(cli/dts): fix plugin example (#10647)

This commit is contained in:
Casper Beyer 2021-05-19 21:07:10 +08:00 committed by Bert Belder
parent 218ba031f0
commit 736ff290b8
No known key found for this signature in database
GPG key ID: 7A77887B2E2ED461
2 changed files with 19 additions and 4 deletions

View file

@ -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.