UI kit reference

code/editor/useFileDocument

import { … } from 'zidane-ui/code/editor'ui/src/code/editor/useFileDocument.ts

Functions#

Loads one adapter file for useCodeDocument and keeps it fresh as the adapter reports changes.

TypeScript

function useFileDocument(fs: FileSystemAdapter, path: string): FileDocumentState

Parameters
Name	Type	Description
fs	`FileSystemAdapter`	Where the file lives.
path	`string`	The file, from the adapter's root.

FileDocumentState

What useFileDocument returns: the file as a CodeDoc plus the save and reload useCodeDocument takes.

TypeScript

interface FileDocumentState

FileDocumentState properties
Name	Type	Description
doc	`CodeDoc \| null`	The latest read; `null` until the first one lands.
error	`string \| null`	Why the file could not be read.
reload	`() => Promise<CodeDoc \| null>`	Reads the file again; `null` when it cannot be read.
save	`(text: string, base: CodeDoc, force: boolean) => Promise<SaveOutcome<CodeDoc>>`	Writes `text`; unless `force`, first checks the file still has `base`'s version and reports `changed` if not.