summaryrefslogtreecommitdiff
path: root/ext/console
diff options
context:
space:
mode:
Diffstat (limited to 'ext/console')
-rw-r--r--ext/console/README.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/ext/console/README.md b/ext/console/README.md
index 2f8fb448a..fab5f8536 100644
--- a/ext/console/README.md
+++ b/ext/console/README.md
@@ -1,5 +1,31 @@
# deno_console
-This crate implements the Console API.
+**This crate implements the Console API.**
Spec: https://console.spec.whatwg.org/
+
+## Usage Example
+
+From javascript, include the extension's source, and assign a console to the
+global scope:
+
+```javascript
+import * as console from "ext:deno_console/01_console.js";
+Object.defineProperty(globalThis, "console", {
+ value: new console.Console((msg, level) =>
+ globalThis.Deno.core.print(msg, level > 1)
+ ),
+ enumerable: false,
+ configurable: true,
+ writable: true,
+});
+```
+
+Then from rust, provide `deno_console::deno_console::init_ops_and_esm()` in the
+`extensions` field of your `RuntimeOptions`
+
+## Provided ops
+
+Following ops are provided, which can be accessed through `Deno.ops`:
+
+- op_preview_entries