@fkn/lib/fs
Type Aliases
Section titled “Type Aliases”AdoptSummary
Section titled “AdoptSummary”type AdoptSummary = object;Properties
Section titled “Properties”deleted
Section titled “deleted”deleted: string[];failed
Section titled “failed”failed: object[];error: string;path: string;kept: string[];resolved
Section titled “resolved”resolved: object[];choice
Section titled “choice”choice: "local" | "cloud" | "merged";path: string;unresolved
Section titled “unresolved”unresolved: string[];uploaded
Section titled “uploaded”uploaded: string[];ConflictResolution
Section titled “ConflictResolution”type ConflictResolution = WriteData | null;What should be at that path. Return one side’s bytes, or anything else as a merge; null leaves the file alone and the summary reports it unresolved.
There is no vocabulary to learn: whatever comes back is what wins. Returning the very Blob that
readLocal() or readCloud() handed you is recognised by identity, so picking a side costs one
write rather than two.
That identity is sound only because the resolver runs in THIS realm: the reads are memoized here,
so the object the app holds is the object compared. A value that crosses osra arrives as a
different object with equal content, in both directions, which tests/osra-identity.browser.test.ts
pins against a real channel. So a resolver whose answer ever crossed a realm would simply read as a
merge: one redundant write, never a wrong file.
ConflictResolver
Section titled “ConflictResolver”type ConflictResolver = (conflict) => | Promise<ConflictResolution> | ConflictResolution;Parameters
Section titled “Parameters”conflict
Section titled “conflict”Returns
Section titled “Returns”| Promise<ConflictResolution>
| ConflictResolution
ConflictSide
Section titled “ConflictSide”type ConflictSide = object;Properties
Section titled “Properties”size: number;updatedAt
Section titled “updatedAt”updatedAt: string | null;FileConflict
Section titled “FileConflict”type FileConflict = object;Properties
Section titled “Properties”cloud: ConflictSide;local: ConflictSide;path: string;readCloud
Section titled “readCloud”readCloud: () => Promise<Blob>;Returns
Section titled “Returns”Promise<Blob>
readLocal
Section titled “readLocal”readLocal: () => Promise<Blob>;Returns
Section titled “Returns”Promise<Blob>
SealedRead
Section titled “SealedRead”type SealedRead = object;The bytes of a cloud object and the seal time they carry, as an ISO string or null.
Properties
Section titled “Properties”data: Uint8Array;sealedAt
Section titled “sealedAt”sealedAt: string | null;type Stats = object;Properties
Section titled “Properties”atimeMs
Section titled “atimeMs”atimeMs: number;ctimeMs
Section titled “ctimeMs”ctimeMs: number;isDirectory
Section titled “isDirectory”isDirectory: () => boolean;Returns
Section titled “Returns”boolean
isFile
Section titled “isFile”isFile: () => boolean;Returns
Section titled “Returns”boolean
isSymbolicLink
Section titled “isSymbolicLink”isSymbolicLink: () => boolean;Returns
Section titled “Returns”boolean
mode: number;mtime: Date;mtimeMs
Section titled “mtimeMs”mtimeMs: number;size: number;Variables
Section titled “Variables”const adopt: () => Promise<AdoptSummary> = hybrid.adopt;Returns
Section titled “Returns”adoptable
Section titled “adoptable”const adoptable: () => Promise<{ bytes: number; paths: string[];}> = hybrid.adoptable;Returns
Section titled “Returns”Promise<{
bytes: number;
paths: string[];
}>
appendFile
Section titled “appendFile”appendFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
appendFileSync
Section titled “appendFileSync”appendFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
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”default: object;Type Declaration
Section titled “Type Declaration”adopt: () => Promise<AdoptSummary>;Returns
Section titled “Returns”adoptable
Section titled “adoptable”adoptable: () => Promise<{ bytes: number; paths: string[];}>;Returns
Section titled “Returns”Promise<{
bytes: number;
paths: string[];
}>
appendFile
Section titled “appendFile”appendFile: (path, data, a, b?) => void;Parameters
Section titled “Parameters”PathLike
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
appendFileSync
Section titled “appendFileSync”appendFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
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>
onConflict
Section titled “onConflict”onConflict: (next) => () => void;Parameters
Section titled “Parameters”Returns
Section titled “Returns”() => void
pending
Section titled “pending”pending: () => string[];Returns
Section titled “Returns”string[]
pendingDeletes
Section titled “pendingDeletes”pendingDeletes: () => string[];Returns
Section titled “Returns”string[]
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
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
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
pull: (path) => Promise<Blob>;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Blob>
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
readFileSealed
Section titled “readFileSealed”readFileSealed: (path) => Promise<SealedRead>;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”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
replicating
Section titled “replicating”replicating: () => boolean;Returns
Section titled “Returns”boolean
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
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
writeFileSync
Section titled “writeFileSync”writeFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
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>
onConflict
Section titled “onConflict”const onConflict: (next) => () => void = hybrid.onConflict;Parameters
Section titled “Parameters”Returns
Section titled “Returns”() => void
pending
Section titled “pending”const pending: () => string[] = hybrid.pending;Returns
Section titled “Returns”string[]
pendingDeletes
Section titled “pendingDeletes”const pendingDeletes: () => string[] = hybrid.pendingDeletes;Returns
Section titled “Returns”string[]
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
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
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”Promise<void>
const pull: (path) => Promise<Blob> = hybrid.pull;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Blob>
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
readFileSealed
Section titled “readFileSealed”const readFileSealed: (path) => Promise<SealedRead> = hybrid.readFileSealed;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”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
replicating
Section titled “replicating”const replicating: () => boolean = hybrid.replicating;Returns
Section titled “Returns”boolean
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
WriteOptions | Callback<void>
Callback<void>
Returns
Section titled “Returns”void
writeFileSync
Section titled “writeFileSync”writeFileSync: (path, data, options?) => void;Parameters
Section titled “Parameters”PathLike
options?
Section titled “options?”WriteOptions
Returns
Section titled “Returns”void