From 257f0273250087bd5080430fe4c780b208d7986c Mon Sep 17 00:00:00 2001 From: Richard Carson Date: Mon, 17 Jun 2024 18:07:48 -0400 Subject: docs: Add documentation to a subset of available extensions (#24138) I was able to use my experience with some of the Deno extensions to flesh out their documentation a bit I've provided docs for the following: - web - fetch - net - webidl - url - io - crypto - console --------- Signed-off-by: Richard Carson --- ext/console/README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) (limited to 'ext/console') 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 -- cgit v1.2.3