1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-22 15:06:54 -05:00
denoland-deno/ext/io/README.md
Richard Carson 257f027325
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 <Rscarson@rogers.com>
2024-06-18 00:07:48 +02:00

24 lines
647 B
Markdown

# deno_io
**This crate provides IO primitives for other Deno extensions, this includes
stdio streams and abstraction over File System files.**
## Usage Example
From javascript, include the extension's source:
```javascript
import * as io from "ext:deno_io/12_io.js";
```
Then from rust, provide:
`deno_io::deno_io::init_ops_and_esm(Option<deno_io::Stdio>)` in the `extensions`
field of your `RuntimeOptions`
Where `deno_io::Stdio` implements `Default`, and can therefore be provided as
`Some(deno_io::Stdio::default())`
## Dependencies
- **deno_web**: Provided by the `deno_web` crate
- **deno_tty**: Provided in `deno/runtime/ops/tty.rs`