ui/client/features/component-docs/services/ComponentsApi
Cockpit client (features), next. Source: ui/client/features/component-docs/services/ComponentsApi.ts.
Functions#
commitComponentSave()#
commitComponentSave(
path,content,contentHash):Promise<SaveResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:23
Commit: hash-checked, architecture-gated, written and committed on save by the server.
Parameters#
path
string
content
string
contentHash
string
Returns#
Promise<SaveResponse>
getComponentDescription()#
getComponentDescription(
path):Promise<DescribeResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:9
Parameters#
path
string
Returns#
Promise<DescribeResponse>
getComponents()#
getComponents():
Promise<{components?:ComponentEntry[];error?:string;ok:boolean; }>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:7
Returns#
Promise<{ components?: ComponentEntry[]; error?: string; ok: boolean; }>
getComponentSource()#
getComponentSource(
path):Promise<SourceResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:11
Parameters#
path
string
Returns#
Promise<SourceResponse>
getComponentUsedBy()#
getComponentUsedBy(
path):Promise<UsedByResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:14
"Used by": which pages import this component, transitively.
Parameters#
path
string
Returns#
Promise<UsedByResponse>
getComponentWorkflow()#
getComponentWorkflow(
path):Promise<ComponentWorkflowResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:17
"State switcher": the workflow machine driving this component, found by the same-name-file convention.
Parameters#
path
string
Returns#
Promise<ComponentWorkflowResponse>
previewComponentSave()#
previewComponentSave(
path,content):Promise<PreviewResponse>
Defined in: ui/client/features/component-docs/services/ComponentsApi.ts:20
Preview: the server returns before/after and writes nothing.
Parameters#
path
string
content
string
Returns#
Promise<PreviewResponse>