Interface FsResponder

Host-side handler for FS-adapter RPC, mirroring the HostFsAdapter/FsDirHandle surface the editor consumes. Each method returns its matching FsResult variant (or throws — serialized into a texbrain:fs:result { ok: false }).

interface FsResponder {
    list(path: string): Promise<{ entries: DirEntry[]; kind: "list" }>;
    mkdir(path: string): Promise<{ kind: "ok" }>;
    readFile(
        path: string,
    ): Promise<{ binary: boolean; data: string; kind: "readFile" }>;
    remove(path: string, recursive: boolean): Promise<{ kind: "ok" }>;
    writeFile(
        path: string,
        data: string,
        binary: boolean,
    ): Promise<{ kind: "ok" }>;
}

Implemented by

Index

Methods

list mkdir readFile remove writeFile

Methods

list

list(path: string): Promise<{ entries: DirEntry[]; kind: "list" }>
values() — list immediate children of a directory.
Parameters
- path: string
Returns Promise<{ entries: DirEntry[]; kind: "list" }>
- Defined in work/linxiv-site/linxiv-site/.sources/linxiv/src/lib/editorBridge.ts:65

mkdir

mkdir(path: string): Promise<{ kind: "ok" }>
getDirectoryHandle(create) — create a directory.
Parameters
- path: string
Returns Promise<{ kind: "ok" }>
- Defined in work/linxiv-site/linxiv-site/.sources/linxiv/src/lib/editorBridge.ts:75

readFile

readFile(
path: string,
): Promise<{ binary: boolean; data: string; kind: "readFile" }>
getFile().text()/arrayBuffer() — read a file (base64 when binary).
Parameters
- path: string
Returns Promise<{ binary: boolean; data: string; kind: "readFile" }>
- Defined in work/linxiv-site/linxiv-site/.sources/linxiv/src/lib/editorBridge.ts:67

remove

remove(path: string, recursive: boolean): Promise<{ kind: "ok" }>
removeEntry — delete a file or directory.
Parameters
- path: string
- recursive: boolean
Returns Promise<{ kind: "ok" }>
- Defined in work/linxiv-site/linxiv-site/.sources/linxiv/src/lib/editorBridge.ts:77

writeFile

writeFile(path: string, data: string, binary: boolean): Promise<{ kind: "ok" }>
createWritable().write — write a file (data is base64 when binary).
Parameters
- path: string
- data: string
- binary: boolean
Returns Promise<{ kind: "ok" }>
- Defined in work/linxiv-site/linxiv-site/.sources/linxiv/src/lib/editorBridge.ts:69

Interface FsResponder

Implemented by

Index

Methods

Methods

list

Parameters

Returns Promise<{ entries: DirEntry[]; kind: "list" }>

mkdir

Parameters

Returns Promise<{ kind: "ok" }>

readFile

Parameters

Returns Promise<{ binary: boolean; data: string; kind: "readFile" }>

remove

Parameters

Returns Promise<{ kind: "ok" }>

writeFile

Parameters

Returns Promise<{ kind: "ok" }>

Settings

On This Page