11# Virtual File System
22
3- <!-- introduced_in=v26.0.0 -->
3+ <!-- introduced_in=REPLACEME -->
44
55<!-- YAML
6- added: v26.0.0
6+ added: REPLACEME
77-->
88
99> Stability: 1 - Experimental
@@ -99,7 +99,7 @@ myVfs.unmount();
9999## ` vfs.create([provider][, options]) `
100100
101101<!-- YAML
102- added: v26.0.0
102+ added: REPLACEME
103103-->
104104
105105* ` provider ` {VirtualProvider} Optional provider instance. Defaults to a new
@@ -143,7 +143,7 @@ const vfsWithOptions = vfs.create({ moduleHooks: false });
143143## Class: ` VirtualFileSystem `
144144
145145<!-- YAML
146- added: v26.0.0
146+ added: REPLACEME
147147-->
148148
149149The ` VirtualFileSystem ` class provides a file system interface backed by a
@@ -153,7 +153,7 @@ make virtual files accessible through the `fs` module.
153153### ` new VirtualFileSystem([provider][, options]) `
154154
155155<!-- YAML
156- added: v26.0.0
156+ added: REPLACEME
157157-->
158158
159159* ` provider ` {VirtualProvider} The provider to use. ** Default:** ` MemoryProvider ` .
@@ -166,7 +166,7 @@ Creates a new `VirtualFileSystem` instance.
166166### ` vfs.provider `
167167
168168<!-- YAML
169- added: v26.0.0
169+ added: REPLACEME
170170-->
171171
172172* {VirtualProvider}
@@ -188,7 +188,7 @@ console.log(myVfs.provider.readonly); // true
188188### ` vfs.mount(prefix) `
189189
190190<!-- YAML
191- added: v26.0.0
191+ added: REPLACEME
192192-->
193193
194194* ` prefix ` {string} The path prefix where the VFS will be mounted.
@@ -211,7 +211,7 @@ require('node:fs').readFileSync('/virtual/data.txt', 'utf8'); // 'Hello'
211211### ` vfs.unmount() `
212212
213213<!-- YAML
214- added: v26.0.0
214+ added: REPLACEME
215215-->
216216
217217Unmounts the virtual file system. After unmounting, virtual files are no longer
@@ -222,7 +222,7 @@ working directory if one was set.
222222### ` vfs.isMounted `
223223
224224<!-- YAML
225- added: v26.0.0
225+ added: REPLACEME
226226-->
227227
228228* {boolean}
@@ -232,7 +232,7 @@ Returns `true` if the VFS is currently mounted.
232232### ` vfs.mountPoint `
233233
234234<!-- YAML
235- added: v26.0.0
235+ added: REPLACEME
236236-->
237237
238238* {string | null}
@@ -242,7 +242,7 @@ The current mount point, or `null` if not mounted.
242242### ` vfs.readonly `
243243
244244<!-- YAML
245- added: v26.0.0
245+ added: REPLACEME
246246-->
247247
248248* {boolean}
@@ -252,7 +252,7 @@ Returns `true` if the underlying provider is read-only.
252252### ` vfs.chdir(path) `
253253
254254<!-- YAML
255- added: v26.0.0
255+ added: REPLACEME
256256-->
257257
258258* ` path ` {string} The new working directory path within the VFS.
@@ -270,7 +270,7 @@ file system paths will throw `ERR_WORKER_UNSUPPORTED_OPERATION`.
270270### ` vfs.cwd() `
271271
272272<!-- YAML
273- added: v26.0.0
273+ added: REPLACEME
274274-->
275275
276276* Returns: {string|null}
@@ -338,7 +338,7 @@ async function example() {
338338## Class: ` VirtualProvider `
339339
340340<!-- YAML
341- added: v26.0.0
341+ added: REPLACEME
342342-->
343343
344344The ` VirtualProvider ` class is an abstract base class for VFS providers.
@@ -349,7 +349,7 @@ Providers implement the actual file system storage and operations.
349349#### ` provider.readonly `
350350
351351<!-- YAML
352- added: v26.0.0
352+ added: REPLACEME
353353-->
354354
355355* {boolean}
@@ -359,7 +359,7 @@ Returns `true` if the provider is read-only.
359359#### ` provider.supportsSymlinks `
360360
361361<!-- YAML
362- added: v26.0.0
362+ added: REPLACEME
363363-->
364364
365365* {boolean}
@@ -397,7 +397,7 @@ class MyProvider extends VirtualProvider {
397397## Class: ` MemoryProvider `
398398
399399<!-- YAML
400- added: v26.0.0
400+ added: REPLACEME
401401-->
402402
403403The ` MemoryProvider ` stores files in memory. It supports full read/write
@@ -412,7 +412,7 @@ const myVfs = create(new MemoryProvider());
412412### ` memoryProvider.setReadOnly() `
413413
414414<!-- YAML
415- added: v26.0.0
415+ added: REPLACEME
416416-->
417417
418418Sets the provider to read-only mode. Once set to read-only, the provider
@@ -438,7 +438,7 @@ myVfs.provider.setReadOnly();
438438## Class: ` SEAProvider `
439439
440440<!-- YAML
441- added: v26.0.0
441+ added: REPLACEME
442442-->
443443
444444The ` SEAProvider ` provides read-only access to assets bundled in a Single
@@ -459,7 +459,7 @@ try {
459459## Class: ` RealFSProvider `
460460
461461<!-- YAML
462- added: v26.0.0
462+ added: REPLACEME
463463-->
464464
465465The ` RealFSProvider ` wraps a real file system directory, allowing it to be
@@ -473,7 +473,7 @@ mounted at a different VFS path. This is useful for:
473473### ` new RealFSProvider(rootPath) `
474474
475475<!-- YAML
476- added: v26.0.0
476+ added: REPLACEME
477477-->
478478
479479* ` rootPath ` {string} The real file system path to use as the provider root.
@@ -534,7 +534,7 @@ if (isMainThread) {
534534### ` realFSProvider.rootPath `
535535
536536<!-- YAML
537- added: v26.0.0
537+ added: REPLACEME
538538-->
539539
540540* {string}
0 commit comments