diff --git a/README.md b/README.md index cbd0d46..1afbf2b 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,59 @@ will cover most scenarios, this library focuses on the file system operations. **Note:** This is work in progress. -## Coverage +## Modules + +### Stat + +Example: + +``` +import { exists } from "@cross/fs/stat"; + +console.log(await exists("my/file")); +// -> true / false +``` + +Methods: + +| Module | Method | Deno | Node | Bun | Browser (LocalStorage) | +| ------ | --------- | ---- | ---- | --- | ---------------------- | +| stat | stat | X | X | X | | +| stat | exists | X | X | X | | +| stat | isDir | X | X | X | | +| stat | isFile | X | X | X | | +| stat | isSymlink | X | X | X | | + +### Io + +Example: + +``` +import { readFile } from "@cross/fs/io"; + +console.log(await readFile("my/file")); +// -> My file content +``` + +| Module | Method | Deno | Node | Bun | Browser (LocalStorage) | +| ------ | --------- | ---- | ---- | --- | ---------------------- | +| io | readFile | X | X | X | | +| io | writeFile | X | X | X | | + +### Ops + +Example: + +``` +import { mktempdir } from "@cross/fs/ops"; + +console.log(await mktempdir("my-prefix")); +// -> /tmp/my-prefix-7a8s78-as67d6as6-asd67a6sd-asdyda/ +``` | Module | Method | Deno | Node | Bun | Browser (LocalStorage) | | ------ | ---------- | ---- | ---- | --- | ---------------------- | -| stat | stat | X | X | X | | -| stat | exists | X | X | X | | -| stat | isDir | X | X | X | | -| stat | isFile | X | X | X | | -| stat | isSymlink | X | X | X | | -| ------ | ---------- | ---- | ---- | --- | ---------------------- | -| io | readFile | X | X | X | | -| io | writeFile | X | X | X | | -| ------ | ---------- | ---- | ---- | --- | ---------------------- | | ops | unlink | X | X | X | | | ops | mkdir | X | X | X | | | ops | mktempdir | X | X | X | | | ops | rmdir | X | X | X | | -| ------ | ---------- | ---- | ---- | --- | ---------------------- |