ui/client/features/pages-editor/services/PageSourceApi
Cockpit client (features), next. Source: ui/client/features/pages-editor/services/PageSourceApi.tsx.
Type Aliases#
LintResult#
LintResult =
object
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:16
Properties#
diagnostics
diagnostics:
SourceDiagnostic[]
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:16
error?
optionalerror?:string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:16
ok?
optionalok?:boolean
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:16
PageSourceResult#
PageSourceResult =
object
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:4
Properties#
contentHash
contentHash:
string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:8
diagnostics
diagnostics:
SourceDiagnostic[]
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:9
error?
optionalerror?:string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:6
ok?
optionalok?:boolean
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:5
source
source:
string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:7
QuickFixMode#
QuickFixMode =
"mechanical"|"ai"
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:22
QuickFixResult#
QuickFixResult =
object
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:23
Properties#
attribution?
optionalattribution?:object
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:23
provider
provider:
string
rule
rule:
string
error?
optionalerror?:string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:23
fixedSource?
optionalfixedSource?:string
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:23
ok?
optionalok?:boolean
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:23
Functions#
getPageSource()#
getPageSource(
feature,file):Promise<PageSourceResult>
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:13
Whole page file + TypeScript/architecture diagnostics (read-only).
Parameters#
feature
string
file
string
Returns#
Promise<PageSourceResult>
lintPageBuffer()#
lintPageBuffer(
feature,file,source):Promise<LintResult>
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:19
— diagnostics for an unsaved buffer, never written to disk.
Parameters#
feature
string
file
string
source
string
Returns#
Promise<LintResult>
quickFixPageBuffer()#
quickFixPageBuffer(
feature,file,source,rule,mode):Promise<QuickFixResult>
Defined in: ui/client/features/pages-editor/services/PageSourceApi.tsx:26
— one quick fix for one diagnostic; returns the fixed buffer to diff and review, never writes.
Parameters#
feature
string
file
string
source
string
rule
string
mode
Returns#
Promise<QuickFixResult>