@ricsam/isolate-fs 0.1.3 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -4
- package/dist/cjs/package.json +1 -1
- package/dist/mjs/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
# @ricsam/isolate-fs
|
|
2
2
|
|
|
3
|
-
File System Access API (OPFS-compatible).
|
|
3
|
+
File System Access API (OPFS-compatible) for isolated-vm V8 sandbox.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm add @ricsam/isolate-fs
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
4
12
|
|
|
5
13
|
```typescript
|
|
6
14
|
import { setupFs } from "@ricsam/isolate-fs";
|
|
@@ -17,12 +25,13 @@ const handle = await setupFs(context, {
|
|
|
17
25
|
});
|
|
18
26
|
```
|
|
19
27
|
|
|
20
|
-
|
|
28
|
+
## Injected Globals
|
|
29
|
+
|
|
21
30
|
- `getDirectory(path)` - Entry point for file system access
|
|
22
31
|
- `FileSystemDirectoryHandle`, `FileSystemFileHandle`
|
|
23
32
|
- `FileSystemWritableFileStream`
|
|
24
33
|
|
|
25
|
-
|
|
34
|
+
## Usage in Isolate
|
|
26
35
|
|
|
27
36
|
```javascript
|
|
28
37
|
// Get directory handle
|
|
@@ -49,4 +58,8 @@ await root.removeEntry("old-dir", { recursive: true });
|
|
|
49
58
|
for await (const [name, handle] of root.entries()) {
|
|
50
59
|
console.log(name, handle.kind); // "file" or "directory"
|
|
51
60
|
}
|
|
52
|
-
```
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT
|
package/dist/cjs/package.json
CHANGED
package/dist/mjs/package.json
CHANGED