Interface: API
_internal.API
Hierarchy
API
Properties
destroy
• destroy: () => Promise
<void
>
Type declaration
▸ (): Promise
<void
>
Returns
Promise
<void
>
Defined in
exec
• exec: (command
: APICommands
, ...args
: any
[]) => Promise
<{ output
: any
} | { error
: string
}>
Type declaration
▸ (command
, ...args
): Promise
<{ output
: any
} | { error
: string
}>
Parameters
Name | Type |
---|---|
command | APICommands |
...args | any [] |
Returns
Promise
<{ output
: any
} | { error
: string
}>
Defined in
format
• format: (allEditors?
: boolean
) => Promise
<void
>
Type declaration
▸ (allEditors?
): Promise
<void
>
Parameters
Name | Type |
---|---|
allEditors? | boolean |
Returns
Promise
<void
>
Defined in
getCode
• getCode: () => Promise
<Code
>
Type declaration
▸ (): Promise
<Code
>
Returns
Promise
<Code
>
Defined in
getConfig
• getConfig: (contentOnly?
: boolean
) => Promise
<Config
>
Type declaration
▸ (contentOnly?
): Promise
<Config
>
Parameters
Name | Type |
---|---|
contentOnly? | boolean |
Returns
Promise
<Config
>
Defined in
getShareUrl
• getShareUrl: (shortUrl?
: boolean
) => Promise
<string
>
Type declaration
▸ (shortUrl?
): Promise
<string
>
Parameters
Name | Type |
---|---|
shortUrl? | boolean |
Returns
Promise
<string
>
Defined in
onChange
• onChange: (fn
: SDKCodeHandler
) => { remove
: () => void
}
Type declaration
▸ (fn
): Object
Runs a callback function when code changes.
Deprecated
Use the watch method instead.
Parameters
Name | Type |
---|---|
fn | SDKCodeHandler |
Returns
Object
Name | Type |
---|---|
remove | () => void |
Defined in
run
• run: () => Promise
<void
>
Type declaration
▸ (): Promise
<void
>
Returns
Promise
<void
>
Defined in
runTests
• runTests: () => Promise
<{ results
: TestResult
[] }>
Type declaration
▸ (): Promise
<{ results
: TestResult
[] }>
Returns
Promise
<{ results
: TestResult
[] }>
Defined in
setConfig
• setConfig: (config
: Partial
<Config
>) => Promise
<Config
>
Type declaration
▸ (config
): Promise
<Config
>
Parameters
Name | Type |
---|---|
config | Partial <Config > |
Returns
Promise
<Config
>
Defined in
show
• show: (panel
: EditorId
| "console"
| "compiled"
| "tests"
| "result"
, options?
: { column?
: number
; full?
: boolean
; line?
: number
; zoom?
: 1
| 0.5
| 0.25
}) => Promise
<void
>
Type declaration
▸ (panel
, options?
): Promise
<void
>
Parameters
Name | Type |
---|---|
panel | EditorId | "console" | "compiled" | "tests" | "result" |
options? | Object |
options.column? | number |
options.full? | boolean |
options.line? | number |
options.zoom? | 1 | 0.5 | 0.25 |
Returns
Promise
<void
>
Defined in
watch
• watch: (event
: "load"
, fn
: SDKGenericHandler
) => { remove
: SDKGenericHandler
} & (event
: "ready"
, fn
: SDKReadyHandler
) => { remove
: SDKGenericHandler
} & (event
: "code"
, fn
: SDKCodeHandler
) => { remove
: SDKGenericHandler
} & (event
: "console"
, fn
: SDKConsoleHandler
) => { remove
: SDKGenericHandler
} & (event
: "tests"
, fn
: SDKTestsHandler
) => { remove
: SDKGenericHandler
} & (event
: "destroy"
, fn
: SDKGenericHandler
) => { remove
: SDKGenericHandler
}