RepackedFileSystem
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:184
The file surface of a repacked store, as a TYPE.
RepackedVfs is the one-store implementation; MountedRepackedVfs is a composite of
several. Everything that takes a store — the sync broker above all — takes this, so a host can
hand it either without the two knowing about each other.
Methods
Section titled “Methods”assertHealthy()
Section titled “assertHealthy()”assertHealthy():
void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:186
Returns
Section titled “Returns”void
chmod()
Section titled “chmod()”chmod(
path,mode,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:217
Parameters
Section titled “Parameters”string
number
bigint
Returns
Section titled “Returns”void
close()
Section titled “close()”Call Signature
Section titled “Call Signature”close():
void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:222
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”close(
fd):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:223
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
fail()
Section titled “fail()”fail(
cause):never
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:187
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”never
fstat()
Section titled “fstat()”fstat(
fd):RepackedStat
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:207
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”lstat()
Section titled “lstat()”lstat(
path):RepackedStat
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:194
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”metrics()
Section titled “metrics()”metrics():
RepackedVfsMetrics
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:188
Returns
Section titled “Returns”mkdir()
Section titled “mkdir()”mkdir(
path,options):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:198
Parameters
Section titled “Parameters”string
options
Section titled “options”number
bigint
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
open()
Section titled “open()”open(
path,flags?,mode?,nowMs?):number
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:206
Parameters
Section titled “Parameters”string
flags?
Section titled “flags?”string
number
nowMs?
Section titled “nowMs?”bigint
Returns
Section titled “Returns”number
read()
Section titled “read()”read(
fd,buffer,offset,length,position?):number
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:208
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position?
Section titled “position?”bigint
Returns
Section titled “Returns”number
readdir()
Section titled “readdir()”readdir(
path):string[]
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:197
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
readFile()
Section titled “readFile()”readFile(
path):Uint8Array
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:204
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Uint8Array
readlink()
Section titled “readlink()”readlink(
path):string
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:196
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
rename()
Section titled “rename()”rename(
oldPath,newPath,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:221
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
bigint
Returns
Section titled “Returns”void
repack()
Section titled “repack()”repack(
reason?):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:189
Parameters
Section titled “Parameters”reason?
Section titled “reason?”RepackReason
Returns
Section titled “Returns”void
resolvePath()
Section titled “resolvePath()”resolvePath(
path,follow?):string
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:192
The link-free absolute path path names; follow governs the final component only.
Parameters
Section titled “Parameters”string
follow?
Section titled “follow?”boolean
Returns
Section titled “Returns”string
rmdir()
Section titled “rmdir()”rmdir(
path,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:220
Parameters
Section titled “Parameters”string
bigint
Returns
Section titled “Returns”void
runScheduledRepack()
Section titled “runScheduledRepack()”runScheduledRepack(
nowMs?):boolean
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:190
Parameters
Section titled “Parameters”nowMs?
Section titled “nowMs?”number
Returns
Section titled “Returns”boolean
stat()
Section titled “stat()”stat(
path):RepackedStat
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:193
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”strictSync()
Section titled “strictSync()”strictSync():
void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:185
Returns
Section titled “Returns”void
symlink()
Section titled “symlink()”symlink(
target,path,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:195
Parameters
Section titled “Parameters”target
Section titled “target”string
string
bigint
Returns
Section titled “Returns”void
truncate()
Section titled “truncate()”truncate(
path,size,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:205
Parameters
Section titled “Parameters”string
bigint
bigint
Returns
Section titled “Returns”void
unlink()
Section titled “unlink()”unlink(
path,nowMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:219
Parameters
Section titled “Parameters”string
bigint
Returns
Section titled “Returns”void
utimes()
Section titled “utimes()”utimes(
path,atimeMs,mtimeMs,ctimeMs):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:218
Parameters
Section titled “Parameters”string
atimeMs
Section titled “atimeMs”bigint
mtimeMs
Section titled “mtimeMs”bigint
ctimeMs
Section titled “ctimeMs”bigint
Returns
Section titled “Returns”void
write()
Section titled “write()”write(
fd,buffer,offset,length,position,nowMs):number
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:209
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position
Section titled “position”bigint | undefined
bigint
Returns
Section titled “Returns”number
writeFile()
Section titled “writeFile()”writeFile(
path,data,options):void
Defined in: packages/pgwasm/src/opfs/core/repacked-vfs.ts:199
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
options
Section titled “options”encoding?
Section titled “encoding?”string
string
number
bigint
Returns
Section titled “Returns”void