Class DslEditor

constructor

• new DslEditor(): DslEditor

  Returns DslEditor

Readonlyelement

Readonlylanguage

ReadonlymonacoEditor

addCommand

• addCommand(keys: string, handler: (editor: DslEditor) => void): void

  Runs handler on a key combination of Monaco KeyMod and KeyCode names, e.g. "CtrlCmd+Enter".

  Parameters

  • keys: string
  • handler: (editor: DslEditor) => void

  Returns void

dispose

• dispose(): void

  Removes the editor from the page and frees it. Call it when the host component goes away.

  Returns void

focus

• focus(): void

  Returns void

format

• format(): Promise<void>

  Formats the text with the language's formatter.

  Returns Promise<void>

getStatus

• getStatus(): DslEditorStatus

  Returns DslEditorStatus

getValue

• getValue(): string

  Returns string

layout

• layout(): void

  Re-measures the container. Automatic, except after it changed size while hidden.

  Returns void

onChange

• onChange(listener: (value: string) => void): () => void

  Returns a function that removes the listener.

  Parameters

  • listener: (value: string) => void

  Returns () => void

onError

• onError(listener: (error: DslServiceError) => void): () => void

  Returns a function that removes the listener.

  Parameters

  • listener: (error: DslServiceError) => void

  Returns () => void

onStatus

• onStatus(listener: (status: DslEditorStatus) => void): () => void

  Returns a function that removes the listener.

  Parameters

  • listener: (status: DslEditorStatus) => void

  Returns () => void

setAddress

• setAddress(address: string): void

  Another instance from now on.

  Parameters

  • address: string

  Returns void

setLanguage

• setLanguage(language: DslLanguage): void

  Switches the language, keeping the text.

  Parameters

  • language: DslLanguage

  Returns void

setModels

• setModels(
      models:
          | string[]
          | (() => string[] | null | undefined)
          | null
          | undefined,
  ): void

  The models whose names completion proposes from now on (DslEditorOptions.models).

  Parameters

  • models: string[] | (() => string[] | null | undefined) | null | undefined

  Returns void

setReadOnly

• setReadOnly(readOnly: boolean): void

  Parameters

  • readOnly: boolean

  Returns void

setTheme

• setTheme(theme: string): void

  Sets the page's theme (every editor follows).

  Parameters

  • theme: string

  Returns void

setToken

• setToken(token: DslToken | (() => DslToken | Promise<DslToken>)): void

  Parameters

  • token: DslToken | (() => DslToken | Promise<DslToken>)

  Returns void

setValue

• setValue(value: string): void

  Replaces the text as one undoable edit; no-op when it is the same text.

  Parameters

  • value: string

  Returns void

validate

• validate(): Promise<DslEditorStatus>

  Validates the current text now; rejects when the services cannot be reached.

  Returns Promise<DslEditorStatus>