Skip to main content

Interface: Playground

Hierarchy​

  • API

    ↳ Playground

Properties​

destroy​

• destroy: () => Promise<void>

Type declaration​

▸ (): Promise<void>

Returns​

Promise<void>

Inherited from​

API.destroy

Defined in​

models.ts:21

exec​

• exec: (command: APICommands, ...args: any[]) => Promise<{ output: any } | { error: string }>

Type declaration​

▸ (command, ...args): Promise<{ output: any } | { error: string }>

Parameters​
NameType
commandAPICommands
...argsany[]
Returns​

Promise<{ output: any } | { error: string }>

Inherited from​

API.exec

Defined in​

models.ts:20

format​

• format: (allEditors?: boolean) => Promise<void>

Type declaration​

▸ (allEditors?): Promise<void>

Parameters​
NameType
allEditors?boolean
Returns​

Promise<void>

Inherited from​

API.format

Defined in​

models.ts:3

getCode​

• getCode: () => Promise<Code>

Type declaration​

▸ (): Promise<Code>

Returns​

Promise<Code>

Inherited from​

API.getCode

Defined in​

models.ts:7

getConfig​

• getConfig: (contentOnly?: boolean) => Promise<Config>

Type declaration​

▸ (contentOnly?): Promise<Config>

Parameters​
NameType
contentOnly?boolean
Returns​

Promise<Config>

Inherited from​

API.getConfig

Defined in​

models.ts:5

getShareUrl​

• getShareUrl: (shortUrl?: boolean) => Promise<string>

Type declaration​

▸ (shortUrl?): Promise<string>

Parameters​
NameType
shortUrl?boolean
Returns​

Promise<string>

Inherited from​

API.getShareUrl

Defined in​

models.ts:4

load​

• load: () => Promise<void>

Type declaration​

▸ (): Promise<void>

Returns​

Promise<void>

Defined in​

models.ts:55

onChange​

• onChange: (fn: SDKCodeHandler) => { remove: () => void }

Runs a callback function when code changes.

Deprecated

Use the watch method instead.

Type declaration​

▸ (fn): Object

Parameters​
NameType
fnSDKCodeHandler
Returns​

Object

NameType
remove() => void

Inherited from​

API.onChange

Defined in​

models.ts:18

run​

• run: () => Promise<void>

Type declaration​

▸ (): Promise<void>

Returns​

Promise<void>

Inherited from​

API.run

Defined in​

models.ts:2

runTests​

• runTests: () => Promise<{ results: TestResult[] }>

Type declaration​

▸ (): Promise<{ results: TestResult[] }>

Returns​

Promise<{ results: TestResult[] }>

Inherited from​

API.runTests

Defined in​

models.ts:12

setConfig​

• setConfig: (config: Partial<Config>) => Promise<Config>

Type declaration​

▸ (config): Promise<Config>

Parameters​
NameType
configPartial<Config>
Returns​

Promise<Config>

Inherited from​

API.setConfig

Defined in​

models.ts:6

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​
NameType
panelEditorId | "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>

Inherited from​

API.show

Defined in​

models.ts:8

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 }

Inherited from​

API.watch

Defined in​

models.ts:19

Sponsors