ui/client/features/component-docs/services/ComponentsApi

Functions#

commitComponentSave(path, content, contentHash): Promise<SaveResponse>

Commit: hash-checked, architecture-gated, written and committed on save by the server.

string

string

string

getComponentDescription(path): Promise<DescribeResponse>

string

getComponents(): Promise<{ components?: ComponentEntry[]; error?: string; ok: boolean; }>

Promise<{ components?: ComponentEntry[]; error?: string; ok: boolean; }>

getComponentSource(path): Promise<SourceResponse>

string

previewComponentSave(path, content): Promise<PreviewResponse>

Preview: the server returns before/after and writes nothing.

string

string