Skip to content

Commit dae621c

Browse files
committed
doc: clarify VFS accepts same types as fs module
Add note that VFS methods accept the same argument types as their fs counterparts, including string, Buffer, TypedArray, and DataView.
1 parent a4514bc commit dae621c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/api/vfs.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,9 @@ Throws `ERR_INVALID_STATE` if `virtualCwd` was not enabled during construction.
315315
The `VirtualFileSystem` class provides methods that mirror the `fs` module API.
316316
All paths are relative to the VFS root (not the mount point).
317317

318+
These methods accept the same argument types as their `fs` counterparts,
319+
including `string`, `Buffer`, `TypedArray`, and `DataView` where applicable.
320+
318321
#### Synchronous Methods
319322

320323
* `vfs.accessSync(path[, mode])` - Check file accessibility

0 commit comments

Comments
 (0)