Skip to content

@jsvision/code-editor / CodeEditorDocumentLifecycleHostEffect

Type Alias: CodeEditorDocumentLifecycleHostEffect ​

CodeEditorDocumentLifecycleHostEffect = { formatting: CodeEditorSaveFormattingOutcome; kind: "save"; originRevision: number; originUri: string; sessionGeneration: number; text: string; } | { kind: "close"; modified: boolean; originRevision: number; originUri: string; sessionGeneration: number; } | { decision: "compare"; kind: "external-change"; modified: boolean; originRevision: number; originUri: string; sessionGeneration: number; text: string; }

Defined in: code-editor/src/document-lifecycle.ts:25

Typed persistence and conflict effects that remain under host authority.

Union Members ​

Type Literal ​

{ formatting: CodeEditorSaveFormattingOutcome; kind: "save"; originRevision: number; originUri: string; sessionGeneration: number; text: string; }

formatting ​

readonly formatting: CodeEditorSaveFormattingOutcome

kind ​

readonly kind: "save"

Requests persistence of one exact source revision.

originRevision ​

readonly originRevision: number

originUri ​

readonly originUri: string

sessionGeneration ​

readonly sessionGeneration: number

text ​

readonly text: string


Type Literal ​

{ kind: "close"; modified: boolean; originRevision: number; originUri: string; sessionGeneration: number; }

kind ​

readonly kind: "close"

Requests permission to close the active document.

modified ​

readonly modified: boolean

originRevision ​

readonly originRevision: number

originUri ​

readonly originUri: string

sessionGeneration ​

readonly sessionGeneration: number


Type Literal ​

{ decision: "compare"; kind: "external-change"; modified: boolean; originRevision: number; originUri: string; sessionGeneration: number; text: string; }

decision ​

readonly decision: "compare"

kind ​

readonly kind: "external-change"

Requests a host-owned comparison without exposing local source text.

modified ​

readonly modified: boolean

originRevision ​

readonly originRevision: number

originUri ​

readonly originUri: string

sessionGeneration ​

readonly sessionGeneration: number

text ​

readonly text: string