CodeRunRequest

One program for a CodeRunner to run.

@internote/canvas-sdkInterface
On this page
import { CodeRunRequest } from '@internote/canvas-sdk';

#Fields

codeRequired
The full program: any setup the environment adds, then exactly what the reader sees.
string
fileName
The name the environment gives its code, so tracebacks read exercise.py rather than a scratch name. The host sanitises it, and falls back to a name of its own when absent.
string
identityRequired
The environment asking, so the host can attribute and scope the run.
EnvironmentIdentity
inputs
Reserved for named inputs such as datasets and files. Always undefined for now.
Record<string, unknown>
languageRequired
The canonical language name, such as python.
string
signal
Aborts the run when the reader presses Stop.
AbortSignal

Declared in packages/canvas-sdk/src/runner/index.ts:50.

Last updated