foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-01-05 05:49:20 -05:00
Code Issues Packages 1 Wiki Activity

docs(core): replaces dispatch references with op (#11054)

Browse source
This commit is contained in:
Max 2021-06-20 12:12:55 -03:00 committed by GitHub
parent 7b559ee89e
commit bbc2745350
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
core/README.md
View file

@ -16,13 +16,16 @@ keeps track of all pending tasks (async ops, dynamic module loads). It is user's
responsibility to drive that loop by using `JsRuntime::run_event_loop` method - responsibility to drive that loop by using `JsRuntime::run_event_loop` method -
it must be executed in the context of Rust's future executor (eg. tokio, smol). it must be executed in the context of Rust's future executor (eg. tokio, smol).
In order to bind Rust functions into JavaScript, use the `Deno.core.dispatch()` In order to bind Rust functions into JavaScript, use the `Deno.core.opSync()`
function to trigger the "dispatch" callback in Rust. The user is responsible for and `Deno.core.opAsync()` functions to trigger the "op_fn" callback in
encoding both the request and response into a Uint8Array. `JsRuntime::register_op` on Rust side. A conventional way to handle "op_fn"
callbacks is to use the `op_sync` and `op_async` functions.
Documentation for this crate is thin at the moment. Please see Documentation for this crate is thin at the moment. Please see
[hello_world.rs](https://github.com/denoland/deno/blob/main/core/examples/hello_world.rs)
and
[http_bench_json_ops.rs](https://github.com/denoland/deno/blob/main/core/examples/http_bench_json_ops.rs) [http_bench_json_ops.rs](https://github.com/denoland/deno/blob/main/core/examples/http_bench_json_ops.rs)
as a simple example of usage. as examples of usage.
TypeScript support and lots of other functionality are not available at this TypeScript support and lots of other functionality are not available at this
layer. See the [CLI](https://github.com/denoland/deno/tree/main/cli) for that. layer. See the [CLI](https://github.com/denoland/deno/tree/main/cli) for that.