0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-03 09:31:22 -05:00

docs(std/fs): provide more context on unstable perm (#6748)

This commit is contained in:
Paul Jones 2020-08-25 06:33:38 -04:00 committed by GitHub
parent c4d5b01acf
commit 54d336ab20
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,8 +4,8 @@ fs module is made to provide helpers to manipulate the filesystem.
## Usage
All the following modules are exposed in `mod.ts` This feature is currently
unstable. To enable it use `deno run --unstable`
Most the following modules are exposed in `mod.ts` This feature is currently
<b>unstable</b>. To enable it use `deno run --unstable`
### emptyDir
@ -174,6 +174,37 @@ async function printFilesNames() {
printFilesNames().then(() => console.log("Done!"));
```
### readFileStr
Read file and output it as a string. Note: this module does not require the
`--unstable` flag.
**ReadOptions**
- encoding : The encoding to read file. lowercased.
```ts
import { readFileStr, readFileStrSync } from "https://deno.land/std/fs/mod.ts";
readFileStr("./target.dat", { encoding: "utf8" }); // returns a promise
readFileStrSync("./target.dat", { encoding: "utf8" }); // string
```
### writeFileStr
Write the string to file. Note: this module does not require the `--unstable`
flag.
```ts
import {
writeFileStr,
writeFileStrSync,
} from "https://deno.land/std/fs/mod.ts";
writeFileStr("./target.dat", "file content"); // returns a promise
writeFileStrSync("./target.dat", "file content"); // void
```
### expandGlob
Expand the glob string from the specified `root` directory and yield each result