DaoPaaS API Options

Type Aliases

BaseConfig

BaseConfig: { hideEditorContextMenu?: boolean; hideEditorToolTip?: boolean }

Type declaration

Optional hideEditorContextMenu?: boolean
Optional hideEditorToolTip?: boolean

CodeSnippetOption

CodeSnippetOption: { option: { detail?: string; label: string }; template: string }

Type declaration

option: { detail?: string; label: string }
- Optional detail?: string
- label: string
template: string

CodeSnippetType

CodeSnippetType: Record<string, CodeSnippetOption[]>

ComponentType

SDK内部组件名

Config

Config: { disableEditable?: boolean; disableFileTreeAction?: boolean }

Type declaration

Optional disableEditable?: boolean
Optional disableFileTreeAction?: boolean

ContextMenu

ContextMenu: ContextMenuItem[][]

ContextMenuItem

ContextMenuItem: { actionName?: string; actionShortcutKey?: string; className?: string; shortcutClassName?: string; shortcutKey?: string; text: {}; textClassName?: string; withCodeFlag?: boolean; actionFun?: any }

Type declaration

Optional actionName?: string
Optional actionShortcutKey?: string
Optional className?: string
Optional shortcutClassName?: string
Optional shortcutKey?: string
text: {}
- [x: string]: ReactI18NextChild | Iterable<ReactI18NextChild>
Optional textClassName?: string
Optional withCodeFlag?: boolean
actionFun?:function
- actionFun(view: EditorView, commands: any, firstNum?: number, lastNum?: number): void
- - Defined in types/DaoPaaS.d.ts:146
  Parameters
  - view: EditorView
  - commands: any
  - Optional firstNum: number
  - Optional lastNum: number
  Returns void

ContextMenuType

ContextMenuType: { items: ContextMenuTypeItem[]; overrideItems?: Pick<ContextMenuTypeItem, "action" | "text">[]; title?: string; handleOverride?: any; handleSelect: any }

Type declaration

items: ContextMenuTypeItem[]
Optional overrideItems?: Pick<ContextMenuTypeItem, "action" | "text">[]
Optional title?: string
handleOverride?:function
- handleOverride(params: IOverrideParams): void
- - Defined in types/DaoPaaS.d.ts:74
  Parameters
  - params: IOverrideParams
  Returns void
handleSelect:function
- handleSelect(e: any, callback?: ((data: any, extralAction: IExtralAction) => void)): void
- - Defined in types/DaoPaaS.d.ts:65
  Parameters
  - e: any
  - Optional callback: ((data: any, extralAction: IExtralAction) => void)
    - - (data: any, extralAction: IExtralAction): void
      - Parameters
        data: any
        extralAction: IExtralAction
        Returns void
  Returns void

ContextMenuTypeItem

ContextMenuTypeItem: { action: string; codeAction?: "append" | "replace"; commentStartLabel: string; commentTips?: string; flag?: string; hideCodeBlock: boolean; icon: string; iconLabel: string; id?: number; isAi?: boolean; isCheck?: boolean; isDone?: boolean; isRepalceRange?: boolea; noActionCheck?: boolean; text: string }

Type declaration

action: string
Optional codeAction?: "append" | "replace"
commentStartLabel: string
Optional commentTips?: string
Optional flag?: string
hideCodeBlock: boolean
icon: string
iconLabel: string
Optional id?: number
Optional isAi?: boolean
Optional isCheck?: boolean
Optional isDone?: boolean
Optional isRepalceRange?: boolea
Optional noActionCheck?: boolean
text: string

DockerStatus

DockerStatus: "RUNNING" | "STOP" | "DEBUG_RUNNING"

Docker运行状态

EditorIndentMode

EditorIndentMode: "space" | "tab"

EditorMode

EditorMode: "default" | "vim" | "emacs"

FileHeaderType

FileHeaderType: { className?: string; icon: { className: string; tips?: TranslateTypeOption; action?: any }; label?: TranslateTypeOption; labelAction?: { label: TranslateTypeOption; tips?: TranslateTypeOption; action: any }; showTips?: boolean; tipsDuration?: number }

Type declaration

Optional className?: string
icon: { className: string; tips?: TranslateTypeOption; action?: any }
- className: string
- Optional tips?: TranslateTypeOption
- action?:function
  - action(): void
  - - Defined in types/DaoPaaS.d.ts:46
    Returns void
Optional label?: TranslateTypeOption
Optional labelAction?: { label: TranslateTypeOption; tips?: TranslateTypeOption; action: any }
- label: TranslateTypeOption
- Optional tips?: TranslateTypeOption
- action:function
  - action(): void
  - - Defined in types/DaoPaaS.d.ts:53
    Returns void
Optional showTips?: boolean
Optional tipsDuration?: number

GlobalConfig

GlobalConfig: { editorIndentMode?: EditorIndentMode; editorMode?: EditorMode; editorTabSize?: number | "auto"; editorWordWrap?: boolean; fontSize?: string; markdownPreview?: { iframeHeight?: string; iframeWidth?: string; isBlank?: boolean }; openDiagnostic?: boolean }

Type declaration

Optional editorIndentMode?: EditorIndentMode
Optional editorMode?: EditorMode
Optional editorTabSize?: number | "auto"
Optional editorWordWrap?: boolean
Optional fontSize?: string
Optional markdownPreview?: { iframeHeight?: string; iframeWidth?: string; isBlank?: boolean }
- Optional iframeHeight?: string
- Optional iframeWidth?: string
- Optional isBlank?: boolean
Optional openDiagnostic?: boolean

ICodeLanguage

IDebugStatus

IDebugStatus: "starting" | "executing" | "executed" | "stop"

starting 正在启动 executing正在执行 executed 执行完成 stop停止

IOverrideParams

IOverrideParams: { action: string; ids: string[] }

Type declaration

action: string
ids: string[]

ISpecialFileHighlight

ISpecialFileHighlight: { fileName: string; languageType: ICodeLanguage }

Type declaration

fileName: string
languageType: ICodeLanguage

InsertCodeLineCode

InsertCodeLineCode: number | "TOP" | "BOTTOM"

Message

Message: { error?: string; name: Messages; payload?: any }

SDK消息监听数据类型

Type declaration

Optional error?: string

错误信息
name: Messages

消息类型
Optional payload?: any

消息内容

PlaygroundStatus

PlaygroundStatus: "EMPTY" | "ACTIVE" | "INACTIVE"

Playground状态类型

ReportHighlightCache

ReportHighlightCache: {}

Type declaration

[key: string]: LineInfo[]

ReportHighlightFileInfo

ReportHighlightFileInfo: { arr: number[]; baseContent: string; path: string }

Type declaration

arr: number[]
baseContent: string
path: string

ResultType

ResultType: { message: string; status: boolean }

Type declaration

message: string
status: boolean

TranslateType

TranslateType: Record<string, Record<TranslateTypeOption>>

TranslateTypeOption

TranslateTypeOption: {}

Type declaration

[x: string]: ReactI18NextChild | Iterable<ReactI18NextChild>

Index

Enumerations

Interfaces Other

Interfaces PaaSOptions [Required]

Type Aliases

Type Aliases

BaseConfig

Type declaration

Optional hideEditorContextMenu?: boolean

Optional hideEditorToolTip?: boolean

CodeSnippetOption

Type declaration

option: { detail?: string; label: string }

Optional detail?: string

label: string

template: string

CodeSnippetType

ComponentType

Config

Type declaration

Optional disableEditable?: boolean

Optional disableFileTreeAction?: boolean

ContextMenu

ContextMenuItem

Type declaration

Optional actionName?: string

Optional actionShortcutKey?: string

Optional className?: string

Optional shortcutClassName?: string

Optional shortcutKey?: string

text: {}

[x: string]: ReactI18NextChild | Iterable<ReactI18NextChild>

Optional textClassName?: string

Optional withCodeFlag?: boolean

actionFun?:function

Parameters

view: EditorView

commands: any

Optional firstNum: number

Optional lastNum: number

Returns void

ContextMenuType

Type declaration

items: ContextMenuTypeItem[]

Optional overrideItems?: Pick<ContextMenuTypeItem, "action" | "text">[]

Optional title?: string

handleOverride?:function

Parameters

params: IOverrideParams

Returns void

handleSelect:function

Parameters

e: any

Optional callback: ((data: any, extralAction: IExtralAction) => void)

Parameters

data: any

extralAction: IExtralAction

Returns void

Returns void

ContextMenuTypeItem

Type declaration

action: string

Optional codeAction?: "append" | "replace"

commentStartLabel: string

Optional commentTips?: string

Optional flag?: string

hideCodeBlock: boolean

icon: string

iconLabel: string

Optional id?: number

Optional isAi?: boolean

Optional isCheck?: boolean

Optional isDone?: boolean

Optional isRepalceRange?: boolea

Optional noActionCheck?: boolean

text: string

DockerStatus

EditorIndentMode

EditorMode

FileHeaderType