OpfsRepackedFS
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:26
The pgwasm filesystem adapter owned by createOpfsPgwasm.
Direct construction is unsupported. The factory retains this adapter so it can close all four handles when host initialization or shutdown fails.
Extends
Section titled “Extends”Properties
Section titled “Properties”
readonlydebug:boolean
Defined in: packages/pgwasm/src/fs/base-filesystem.ts:81
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”description
Section titled “description”Get Signature
Section titled “Get Signature”get description():
FilesystemDescription
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:37
An OPFS-repacked store: its data directory outlives the page.
Returns
Section titled “Returns”Overrides
Section titled “Overrides”recentSyscallErrors
Section titled “recentSyscallErrors”Get Signature
Section titled “Get Signature”get recentSyscallErrors(): readonly
SyscallError[]
Defined in: packages/pgwasm/src/fs/base-filesystem.ts:98
The most recent failed filesystem calls reported to Postgres (up to 50), oldest first.
Returns
Section titled “Returns”readonly SyscallError[]
Inherited from
Section titled “Inherited from”BaseFilesystem.recentSyscallErrors
Methods
Section titled “Methods”chmod()
Section titled “chmod()”chmod(
path,mode):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:66
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”close()
Section titled “close()”close(
fd):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:70
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”closeFs()
Section titled “closeFs()”closeFs():
Promise<void>
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:62
Release everything the filesystem holds. Called when the database closes.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”fstat()
Section titled “fstat()”fstat(
fd):FsStats
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:74
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Overrides
Section titled “Overrides”initialSyncFs()
Section titled “initialSyncFs()”initialSyncFs():
Promise<void>
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:41
Called once when the build mounts the filesystem, before anything reads it.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”lstat()
Section titled “lstat()”lstat(
path):FsStats
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:78
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Overrides
Section titled “Overrides”mkdir()
Section titled “mkdir()”mkdir(
path,options?):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:82
Parameters
Section titled “Parameters”string
options?
Section titled “options?”number
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”open()
Section titled “open()”open(
path,flags?,mode?):number
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:90
Parameters
Section titled “Parameters”string
flags?
Section titled “flags?”string = "r+"
number = 0o100666
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”read()
Section titled “read()”read(
fd,buffer,offset,length,position):number
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:98
Read into buffer[offset, offset + length) from position; returns the bytes read.
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position
Section titled “position”number
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”readdir()
Section titled “readdir()”readdir(
path):string[]
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
Overrides
Section titled “Overrides”recordSyscallError()
Section titled “recordSyscallError()”recordSyscallError(
op,path,errno,message):void
Defined in: packages/pgwasm/src/fs/base-filesystem.ts:103
Record a failed call. The build’s mount calls this where it turns a thrown error into an errno.
Parameters
Section titled “Parameters”string
string
number
message
Section titled “message”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”BaseFilesystem.recordSyscallError
rename()
Section titled “rename()”rename(
oldPath,newPath):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:102
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):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:106
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”strictSync()
Section titled “strictSync()”strictSync():
void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:53
Stabilize every preceding data and metadata operation in strict order.
Returns
Section titled “Returns”void
syncToFs()
Section titled “syncToFs()”syncToFs(
relaxedDurability?):Promise<void>
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:45
Make everything written so far durable. relaxed is pgwasm’s background persist.
Parameters
Section titled “Parameters”relaxedDurability?
Section titled “relaxedDurability?”boolean = false
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”truncate()
Section titled “truncate()”truncate(
path,length):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:110
Parameters
Section titled “Parameters”string
length
Section titled “length”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”unlink()
Section titled “unlink()”unlink(
path):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:114
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”utimes()
Section titled “utimes()”utimes(
path,atime,mtime):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:118
Parameters
Section titled “Parameters”string
number
number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”write()
Section titled “write()”write(
fd,buffer,offset,length,position):number
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:135
Write buffer[offset, offset + length) at position; returns the bytes written.
Parameters
Section titled “Parameters”number
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
length
Section titled “length”number
position
Section titled “position”number
Returns
Section titled “Returns”number
Overrides
Section titled “Overrides”writeFile()
Section titled “writeFile()”writeFile(
path,data,options?):void
Defined in: packages/pgwasm/src/opfs/opfs-repacked-fs.ts:122
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
options?
Section titled “options?”encoding?
Section titled “encoding?”string
string
number
Returns
Section titled “Returns”void