WasiPreview1Fs
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:279
The adapter: the WASI surface plus the three composition/lifecycle helpers a host needs.
Extends
Section titled “Extends”Methods
Section titled “Methods”closeAll()
Section titled “closeAll()”closeAll():
number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:296
Close every descriptor, returning how many were released. The call a thread makes on its way out: without it the coordinator holds the thread’s store descriptors until the whole channel detaches.
Returns
Section titled “Returns”number
compose()
Section titled “compose()”compose(
base):Record<string,unknown>
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:291
A merged wasi_snapshot_preview1 object: every filesystem call goes to the adapter when the fd
(or the dirfd, for a path operation) is adapter-owned and to base otherwise. Everything in
base that is not a filesystem call — args_get, clock_time_get, poll_oneoff, proc_exit,
random_get, sched_yield, the socket stubs — is carried through untouched, as are base’s own
fd 0/1/2 handlers.
Parameters
Section titled “Parameters”Readonly<Record<string, unknown>>
Returns
Section titled “Returns”Record<string, unknown>
fd_advise()
Section titled “fd_advise()”fd_advise(
fd,offset,length,advice):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:232
Parameters
Section titled “Parameters”number
offset
Section titled “offset”bigint
length
Section titled “length”bigint
advice
Section titled “advice”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_advise
fd_allocate()
Section titled “fd_allocate()”fd_allocate(
fd,offset,length):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:231
Parameters
Section titled “Parameters”number
offset
Section titled “offset”bigint
length
Section titled “length”bigint
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_allocate
fd_close()
Section titled “fd_close()”fd_close(
fd):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:215
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_close
fd_datasync()
Section titled “fd_datasync()”fd_datasync(
fd):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:230
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_datasync
fd_fdstat_get()
Section titled “fd_fdstat_get()”fd_fdstat_get(
fd,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:222
Parameters
Section titled “Parameters”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_fdstat_get
fd_fdstat_set_flags()
Section titled “fd_fdstat_set_flags()”fd_fdstat_set_flags(
fd,fdflags):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:223
Parameters
Section titled “Parameters”number
fdflags
Section titled “fdflags”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_fdstat_set_flags
fd_fdstat_set_rights()
Section titled “fd_fdstat_set_rights()”fd_fdstat_set_rights(
fd,rightsBase,rightsInheriting):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:224
Parameters
Section titled “Parameters”number
rightsBase
Section titled “rightsBase”bigint
rightsInheriting
Section titled “rightsInheriting”bigint
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_fdstat_set_rights
fd_filestat_get()
Section titled “fd_filestat_get()”fd_filestat_get(
fd,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:225
Parameters
Section titled “Parameters”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_filestat_get
fd_filestat_set_size()
Section titled “fd_filestat_set_size()”fd_filestat_set_size(
fd,size):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:226
Parameters
Section titled “Parameters”number
bigint
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_filestat_set_size
fd_filestat_set_times()
Section titled “fd_filestat_set_times()”fd_filestat_set_times(
fd,atim,mtim,fstflags):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:227
Parameters
Section titled “Parameters”number
bigint
bigint
fstflags
Section titled “fstflags”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_filestat_set_times
fd_pread()
Section titled “fd_pread()”fd_pread(
fd,iovsPtr,iovsLen,offset,nreadPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:217
Parameters
Section titled “Parameters”number
iovsPtr
Section titled “iovsPtr”number
iovsLen
Section titled “iovsLen”number
offset
Section titled “offset”bigint
nreadPtr
Section titled “nreadPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_pread
fd_prestat_dir_name()
Section titled “fd_prestat_dir_name()”fd_prestat_dir_name(
fd,pathPtr,pathLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:214
Parameters
Section titled “Parameters”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_prestat_dir_name
fd_prestat_get()
Section titled “fd_prestat_get()”fd_prestat_get(
fd,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:213
Parameters
Section titled “Parameters”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_prestat_get
fd_pwrite()
Section titled “fd_pwrite()”fd_pwrite(
fd,iovsPtr,iovsLen,offset,nwrittenPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:219
Parameters
Section titled “Parameters”number
iovsPtr
Section titled “iovsPtr”number
iovsLen
Section titled “iovsLen”number
offset
Section titled “offset”bigint
nwrittenPtr
Section titled “nwrittenPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_pwrite
fd_read()
Section titled “fd_read()”fd_read(
fd,iovsPtr,iovsLen,nreadPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:216
Parameters
Section titled “Parameters”number
iovsPtr
Section titled “iovsPtr”number
iovsLen
Section titled “iovsLen”number
nreadPtr
Section titled “nreadPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_read
fd_readdir()
Section titled “fd_readdir()”fd_readdir(
fd,bufPtr,bufLen,cookie,bufusedPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:228
Parameters
Section titled “Parameters”number
bufPtr
Section titled “bufPtr”number
bufLen
Section titled “bufLen”number
cookie
Section titled “cookie”bigint
bufusedPtr
Section titled “bufusedPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_readdir
fd_seek()
Section titled “fd_seek()”fd_seek(
fd,offset,whence,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:220
Parameters
Section titled “Parameters”number
offset
Section titled “offset”bigint
whence
Section titled “whence”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_seek
fd_sync()
Section titled “fd_sync()”fd_sync(
fd):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:229
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_sync
fd_tell()
Section titled “fd_tell()”fd_tell(
fd,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:221
Parameters
Section titled “Parameters”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_tell
fd_write()
Section titled “fd_write()”fd_write(
fd,iovsPtr,iovsLen,nwrittenPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:218
Parameters
Section titled “Parameters”number
iovsPtr
Section titled “iovsPtr”number
iovsLen
Section titled “iovsLen”number
nwrittenPtr
Section titled “nwrittenPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.fd_write
openFdCount()
Section titled “openFdCount()”openFdCount():
number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:283
How many descriptors the adapter currently holds, preopen excluded.
Returns
Section titled “Returns”number
owns()
Section titled “owns()”owns(
fd):boolean
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:281
Whether this adapter answers for fd: the preopen, or anything at or above fdBase.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”boolean
path_create_directory()
Section titled “path_create_directory()”path_create_directory(
dirfd,pathPtr,pathLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:254
Parameters
Section titled “Parameters”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_create_directory
path_filestat_get()
Section titled “path_filestat_get()”path_filestat_get(
dirfd,flags,pathPtr,pathLen,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:244
Parameters
Section titled “Parameters”number
number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_filestat_get
path_filestat_set_times()
Section titled “path_filestat_set_times()”path_filestat_set_times(
dirfd,flags,pathPtr,pathLen,atim,mtim,fstflags):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:245
Parameters
Section titled “Parameters”number
number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
bigint
bigint
fstflags
Section titled “fstflags”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_filestat_set_times
path_link()
Section titled “path_link()”path_link(
oldDirfd,oldFlags,oldPtr,oldLen,newDirfd,newPtr,newLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:267
Parameters
Section titled “Parameters”oldDirfd
Section titled “oldDirfd”number
oldFlags
Section titled “oldFlags”number
oldPtr
Section titled “oldPtr”number
oldLen
Section titled “oldLen”number
newDirfd
Section titled “newDirfd”number
newPtr
Section titled “newPtr”number
newLen
Section titled “newLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_link
path_open()
Section titled “path_open()”path_open(
dirfd,dirflags,pathPtr,pathLen,oflags,rightsBase,rightsInheriting,fdflags,resultPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:233
Parameters
Section titled “Parameters”number
dirflags
Section titled “dirflags”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
oflags
Section titled “oflags”number
rightsBase
Section titled “rightsBase”bigint
rightsInheriting
Section titled “rightsInheriting”bigint
fdflags
Section titled “fdflags”number
resultPtr
Section titled “resultPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_open
path_readlink()
Section titled “path_readlink()”path_readlink(
dirfd,pathPtr,pathLen,bufPtr,bufLen,bufusedPtr):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:258
Parameters
Section titled “Parameters”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
bufPtr
Section titled “bufPtr”number
bufLen
Section titled “bufLen”number
bufusedPtr
Section titled “bufusedPtr”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_readlink
path_remove_directory()
Section titled “path_remove_directory()”path_remove_directory(
dirfd,pathPtr,pathLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:255
Parameters
Section titled “Parameters”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_remove_directory
path_rename()
Section titled “path_rename()”path_rename(
dirfd,oldPtr,oldLen,newDirfd,newPtr,newLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:257
Parameters
Section titled “Parameters”number
oldPtr
Section titled “oldPtr”number
oldLen
Section titled “oldLen”number
newDirfd
Section titled “newDirfd”number
newPtr
Section titled “newPtr”number
newLen
Section titled “newLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_rename
path_symlink()
Section titled “path_symlink()”path_symlink(
oldPtr,oldLen,dirfd,newPtr,newLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:266
Parameters
Section titled “Parameters”oldPtr
Section titled “oldPtr”number
oldLen
Section titled “oldLen”number
number
newPtr
Section titled “newPtr”number
newLen
Section titled “newLen”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”WasiPreview1FsFunctions.path_symlink
path_unlink_file()
Section titled “path_unlink_file()”path_unlink_file(
dirfd,pathPtr,pathLen):number
Defined in: packages/pgwasm/src/opfs/wasi/preview1.ts:256
Parameters
Section titled “Parameters”number
pathPtr
Section titled “pathPtr”number
pathLen
Section titled “pathLen”number
Returns
Section titled “Returns”number