CopyOnWriteFS
Defined in: src/backends/cow.ts:131
Internal
Using a readable file system as a base, writes are done to a writable file system.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CopyOnWriteFS(
readable,writable,journal?):CopyOnWriteFS
Defined in: src/backends/cow.ts:142
Parameters
Section titled “Parameters”readable
Section titled “readable”The file system that initially populates this file system.
writable
Section titled “writable”The file system to write modified files to.
journal?
Section titled “journal?”Journal = ...
The journal to use for persisting deletions
Returns
Section titled “Returns”CopyOnWriteFS
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_mountPoint?
Section titled “_mountPoint?”
protectedoptional_mountPoint?:string
Defined in: src/internal/filesystem.ts:162
Internal
The last place this file system was mounted
Inherited from
Section titled “Inherited from”
protected_uuid:`${string}-${string}-${string}-${string}-${string}`
Defined in: src/internal/filesystem.ts:169
Internal
The UUID of the file system.
Inherited from
Section titled “Inherited from”attributes
Section titled “attributes”
readonlyattributes:ConstMap<FileSystemAttributes, keyofFileSystemAttributes,void|CaseFold|undefined> &Map<string,any>
Defined in: src/internal/filesystem.ts:178
FileSystemAttributes
Inherited from
Section titled “Inherited from”
protectedinos:Map<string,number>
Defined in: src/backends/cow.ts:172
Inode numbers presented to the VFS for each path.
The readable and writable layers allocate inode numbers independently, so they can collide.
They can not be used as-is, since the VFS uses ino to tell files apart.
This also keeps a file’s inode number stable when it is copied up to the writable layer.
journal
Section titled “journal”
readonlyjournal:Journal
Defined in: src/backends/cow.ts:150
The journal to use for persisting deletions
label?
Section titled “label?”
optionallabel?:string
Defined in: src/internal/filesystem.ts:156
Inherited from
Section titled “Inherited from”
readonlyname:string
Defined in: src/internal/filesystem.ts:191
The name for this file system. For example, tmpfs for an in memory one
Inherited from
Section titled “Inherited from”readable
Section titled “readable”
readonlyreadable:FileSystem
Defined in: src/backends/cow.ts:144
The file system that initially populates this file system.
readonlytype:number
Defined in: src/internal/filesystem.ts:185
A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something
Inherited from
Section titled “Inherited from”writable
Section titled “writable”
readonlywritable:FileSystem
Defined in: src/backends/cow.ts:147
The file system to write modified files to.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get uuid():
`${string}-${string}-${string}-${string}-${string}`
Defined in: src/internal/filesystem.ts:171
Returns
Section titled “Returns”`${string}-${string}-${string}-${string}-${string}`
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”createFile()
Section titled “createFile()”createFile(
path,options):Promise<InodeLike<number>>
Defined in: src/backends/cow.ts:302
Create the file at path with the given options.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<InodeLike<number>>
Overrides
Section titled “Overrides”createFileSync()
Section titled “createFileSync()”createFileSync(
path,options):InodeLike
Defined in: src/backends/cow.ts:309
Create the file at path with the given options.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
path):Promise<boolean>
Defined in: src/internal/filesystem.ts:257
Test whether or not path exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”existsSync()
Section titled “existsSync()”existsSync(
path):boolean
Defined in: src/internal/filesystem.ts:269
Test whether or not path exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ioctl()
Section titled “ioctl()”ioctl(
context,command, …args):Promise<any>
Defined in: src/internal/filesystem.ts:359
Internal
Parameters
Section titled “Parameters”context
Section titled “context”IoctlContext
command
Section titled “command”number
…any[]
Returns
Section titled “Returns”Promise<any>
Inherited from
Section titled “Inherited from”ioctlSync()
Section titled “ioctlSync()”ioctlSync(
context,command, …args):any
Defined in: src/internal/filesystem.ts:367
Internal
Parameters
Section titled “Parameters”context
Section titled “context”IoctlContext
command
Section titled “command”number
…any[]
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”isDeleted()
Section titled “isDeleted()”isDeleted(
path):boolean
Defined in: src/backends/cow.ts:161
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
link()
Section titled “link()”link(
srcpath,dstpath):Promise<void>
Defined in: src/backends/cow.ts:316
Parameters
Section titled “Parameters”srcpath
Section titled “srcpath”string
dstpath
Section titled “dstpath”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”linkSync()
Section titled “linkSync()”linkSync(
srcpath,dstpath):void
Defined in: src/backends/cow.ts:322
Parameters
Section titled “Parameters”srcpath
Section titled “srcpath”string
dstpath
Section titled “dstpath”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”mkdir()
Section titled “mkdir()”mkdir(
path,options):Promise<InodeLike<number>>
Defined in: src/backends/cow.ts:388
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<InodeLike<number>>
Overrides
Section titled “Overrides”mkdirSync()
Section titled “mkdirSync()”mkdirSync(
path,options):InodeLike
Defined in: src/backends/cow.ts:396
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Overrides
Section titled “Overrides”read()
Section titled “read()”read(
path,buffer,offset,end):Promise<void>
Defined in: src/backends/cow.ts:224
Reads into a buffer
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to read into. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
number
The position in the file to stop reading
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”readdir()
Section titled “readdir()”readdir(
path):Promise<string[]>
Defined in: src/backends/cow.ts:404
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
Overrides
Section titled “Overrides”readdirSync()
Section titled “readdirSync()”readdirSync(
path):string[]
Defined in: src/backends/cow.ts:422
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
Overrides
Section titled “Overrides”readSync()
Section titled “readSync()”readSync(
path,buffer,offset,end):void
Defined in: src/backends/cow.ts:230
Reads into a buffer
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to read into. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
number
The position in the file to stop reading
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ready()
Section titled “ready()”ready():
Promise<void>
Defined in: src/backends/cow.ts:132
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”readySync()
Section titled “readySync()”readySync():
void
Defined in: src/backends/cow.ts:137
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”remapIno()
Section titled “remapIno()”
protectedremapIno(path,inode):InodeLike
Defined in: src/backends/cow.ts:196
Replaces the layer’s inode number with the public one for path
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”rename()
Section titled “rename()”rename(
oldPath,newPath):Promise<void>
Defined in: src/backends/cow.ts:244
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”renameInos()
Section titled “renameInos()”
protectedrenameInos(oldPath,newPath):void
Defined in: src/backends/cow.ts:176
Moves the public inode numbers for a rename, including a directory’s descendants
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”void
renameSync()
Section titled “renameSync()”renameSync(
oldPath,newPath):void
Defined in: src/backends/cow.ts:259
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”rmdir()
Section titled “rmdir()”rmdir(
path):Promise<void>
Defined in: src/backends/cow.ts:358
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”rmdirSync()
Section titled “rmdirSync()”rmdirSync(
path):void
Defined in: src/backends/cow.ts:373
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”stat()
Section titled “stat()”stat(
path):Promise<InodeLike<number>>
Defined in: src/backends/cow.ts:274
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<InodeLike<number>>
Overrides
Section titled “Overrides”statSync()
Section titled “statSync()”statSync(
path):InodeLike
Defined in: src/backends/cow.ts:283
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Overrides
Section titled “Overrides”streamRead()
Section titled “streamRead()”streamRead(
path,options):ReadableStream
Defined in: src/backends/cow.ts:452
Read a file using a stream.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”ReadableStream
Overrides
Section titled “Overrides”streamWrite()
Section titled “streamWrite()”streamWrite(
path,options):WritableStream
Defined in: src/backends/cow.ts:456
Write a file using stream.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”WritableStream
Overrides
Section titled “Overrides”sync()
Section titled “sync()”sync():
Promise<void>
Defined in: src/backends/cow.ts:216
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”syncSync()
Section titled “syncSync()”syncSync():
void
Defined in: src/backends/cow.ts:220
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”toString()
Section titled “toString()”toString():
string
Defined in: src/internal/filesystem.ts:197
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”touch()
Section titled “touch()”touch(
path,metadata):Promise<void>
Defined in: src/backends/cow.ts:292
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”touchSync()
Section titled “touchSync()”touchSync(
path,metadata):void
Defined in: src/backends/cow.ts:297
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”unlink()
Section titled “unlink()”unlink(
path):Promise<void>
Defined in: src/backends/cow.ts:328
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”unlinkSync()
Section titled “unlinkSync()”unlinkSync(
path):void
Defined in: src/backends/cow.ts:343
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”usage()
Section titled “usage()”usage():
UsageInfo
Defined in: src/backends/cow.ts:212
Returns
Section titled “Returns”Consider trying to track information on the writable as well
Overrides
Section titled “Overrides”write()
Section titled “write()”write(
path,buffer,offset):Promise<void>
Defined in: src/backends/cow.ts:234
Writes a buffer to a file
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to write. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”writeSync()
Section titled “writeSync()”writeSync(
path,buffer,offset):void
Defined in: src/backends/cow.ts:239
Writes a buffer to a file
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to write. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”void