@fkn/lib/opfs
Variables
Section titled “Variables”appendFile
Section titled “appendFile”appendFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
appendFileSync
Section titled “appendFileSync”appendFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”void
available
Section titled “available”available: () => Promise<boolean>;Returns
Section titled “Returns”Promise<boolean>
default
Section titled “default”const default: object;Type Declaration
Section titled “Type Declaration”appendFile
Section titled “appendFile”appendFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
appendFileSync
Section titled “appendFileSync”appendFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”void
available
Section titled “available”available: () => Promise<boolean> = backing.available;Returns
Section titled “Returns”Promise<boolean>
exists
Section titled “exists”exists: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”(exists) => void
Returns
Section titled “Returns”void
existsSync
Section titled “existsSync”existsSync: (path) => boolean;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”boolean
flush: () => Promise<void> = store.flush;Returns
Section titled “Returns”Promise<void>
lstatSync
Section titled “lstatSync”lstatSync: (path) => Stats = statSync;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”mkdir: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
MakeOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
mkdirSync
Section titled “mkdirSync”mkdirSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”void
mount: () => Promise<void> = store.mount;Returns
Section titled “Returns”Promise<void>
promises
Section titled “promises”promises: object;promises.access
Section titled “promises.access”access: (path) => Promise<void>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<void>
promises.appendFile
Section titled “promises.appendFile”appendFile: (path, data, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
promises.lstat
Section titled “promises.lstat”lstat: (path) => Promise<Stats>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”promises.mkdir
Section titled “promises.mkdir”mkdir: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”Promise<void>
promises.readdir
Section titled “promises.readdir”readdir: (path) => Promise<string[]>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<string[]>
promises.readFile
Section titled “promises.readFile”readFile: (path, options?) => Promise<string | Buffer<ArrayBufferLike>>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”ReadOptions
Returns
Section titled “Returns”Promise<string | Buffer<ArrayBufferLike>>
promises.rename
Section titled “promises.rename”rename: (from, to) => Promise<void>;Parameters
Section titled “Parameters”PathLike
PathLike
Returns
Section titled “Returns”Promise<void>
promises.rm
Section titled “promises.rm”rm: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”force?
Section titled “force?”boolean
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
promises.rmdir
Section titled “promises.rmdir”rmdir: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
promises.stat
Section titled “promises.stat”stat: (path) => Promise<Stats>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”promises.unlink
Section titled “promises.unlink”unlink: (path) => Promise<void>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<void>
promises.writeFile
Section titled “promises.writeFile”writeFile: (path, data, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
readdir
Section titled “readdir”readdir: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
unknown
Callback<string[]>
Returns
Section titled “Returns”void
readdirSync
Section titled “readdirSync”readdirSync: (path) => string[];Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”string[]
readFile
Section titled “readFile”readFile: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
ReadOptions | Callback<string | Buffer<ArrayBufferLike>>
Callback<string | Buffer<ArrayBufferLike>>
Returns
Section titled “Returns”void
readFileSync
Section titled “readFileSync”readFileSync: (path, options?) => string | Buffer<ArrayBufferLike>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”ReadOptions
Returns
Section titled “Returns”string | Buffer<ArrayBufferLike>
remount
Section titled “remount”remount: () => Promise<void> = store.remount;Returns
Section titled “Returns”Promise<void>
rename
Section titled “rename”rename: (from, to, callback) => void;Parameters
Section titled “Parameters”PathLike
PathLike
callback
Section titled “callback”Callback<void>
Returns
Section titled “Returns”void
renameSync
Section titled “renameSync”renameSync: (from, to) => void;Parameters
Section titled “Parameters”PathLike
PathLike
Returns
Section titled “Returns”void
rm: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
| Callback<void>
| {
force?: boolean;
recursive?: boolean;
}
Callback<void>
Returns
Section titled “Returns”void
rmdirSync
Section titled “rmdirSync”rmdirSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
rmSync
Section titled “rmSync”rmSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”force?
Section titled “force?”boolean
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
stat: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”Callback<Stats>
Returns
Section titled “Returns”void
statSync
Section titled “statSync”statSync: (path) => Stats;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”unlink
Section titled “unlink”unlink: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”Callback<void>
Returns
Section titled “Returns”void
unlinkSync
Section titled “unlinkSync”unlinkSync: (path) => void;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”void
writeFile
Section titled “writeFile”writeFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
writeFileSync
Section titled “writeFileSync”writeFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”void
exists
Section titled “exists”exists: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”(exists) => void
Returns
Section titled “Returns”void
existsSync
Section titled “existsSync”existsSync: (path) => boolean;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”boolean
flush: () => Promise<void>;Returns
Section titled “Returns”Promise<void>
lstatSync
Section titled “lstatSync”lstatSync: (path) => Stats;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”mkdir: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
MakeOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
mkdirSync
Section titled “mkdirSync”mkdirSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”void
mount: () => Promise<void>;Returns
Section titled “Returns”Promise<void>
promises
Section titled “promises”promises: object;Type Declaration
Section titled “Type Declaration”access
Section titled “access”access: (path) => Promise<void>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<void>
appendFile
Section titled “appendFile”appendFile: (path, data, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
lstat: (path) => Promise<Stats>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”mkdir: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”Promise<void>
readdir
Section titled “readdir”readdir: (path) => Promise<string[]>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<string[]>
readFile
Section titled “readFile”readFile: (path, options?) => Promise<string | Buffer<ArrayBufferLike>>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”ReadOptions
Returns
Section titled “Returns”Promise<string | Buffer<ArrayBufferLike>>
rename
Section titled “rename”rename: (from, to) => Promise<void>;Parameters
Section titled “Parameters”PathLike
PathLike
Returns
Section titled “Returns”Promise<void>
rm: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”force?
Section titled “force?”boolean
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
rmdir: (path, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
stat: (path) => Promise<Stats>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”unlink
Section titled “unlink”unlink: (path) => Promise<void>;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”Promise<void>
writeFile
Section titled “writeFile”writeFile: (path, data, options?) => Promise<void>;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
readdir
Section titled “readdir”readdir: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
unknown
Callback<string[]>
Returns
Section titled “Returns”void
readdirSync
Section titled “readdirSync”readdirSync: (path) => string[];Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”string[]
readFile
Section titled “readFile”readFile: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
ReadOptions | Callback<string | Buffer<ArrayBufferLike>>
Callback<string | Buffer<ArrayBufferLike>>
Returns
Section titled “Returns”void
readFileSync
Section titled “readFileSync”readFileSync: (path, options?) => string | Buffer<ArrayBufferLike>;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”ReadOptions
Returns
Section titled “Returns”string | Buffer<ArrayBufferLike>
remount
Section titled “remount”remount: () => Promise<void>;Returns
Section titled “Returns”Promise<void>
rename
Section titled “rename”rename: (from, to, callback) => void;Parameters
Section titled “Parameters”PathLike
PathLike
callback
Section titled “callback”Callback<void>
Returns
Section titled “Returns”void
renameSync
Section titled “renameSync”renameSync: (from, to) => void;Parameters
Section titled “Parameters”PathLike
PathLike
Returns
Section titled “Returns”void
rm: (path, a, b?) => void;Parameters
Section titled “Parameters”PathLike
| Callback<void>
| {
force?: boolean;
recursive?: boolean;
}
Callback<void>
Returns
Section titled “Returns”void
rmdirSync
Section titled “rmdirSync”rmdirSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
rmSync
Section titled “rmSync”rmSync: (path, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”force?
Section titled “force?”boolean
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”void
stat: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”Callback<Stats>
Returns
Section titled “Returns”void
statSync
Section titled “statSync”statSync: (path) => Stats;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”unlink
Section titled “unlink”unlink: (path, callback) => void;Parameters
Section titled “Parameters”PathLike
callback
Section titled “callback”Callback<void>
Returns
Section titled “Returns”void
unlinkSync
Section titled “unlinkSync”unlinkSync: (path) => void;Parameters
Section titled “Parameters”PathLike
Returns
Section titled “Returns”void
writeFile
Section titled “writeFile”writeFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
writeFileSync
Section titled “writeFileSync”writeFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
WriteData
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”void
References
Section titled “References”Re-exports Stats