Interface Kernel

Represents a Jupyter Kernel.

interface Kernel {
    language: string;
    onDidChangeStatus: Event<KernelStatus>;
    status: KernelStatus;
    executeCode(code: string, token: CancellationToken): AsyncIterable<Output>;
}

Index

Properties

language onDidChangeStatus status

Methods

Properties

`Readonly`language

language: string

Language of the kernel (e.g., python, r, julia).

onDidChangeStatus

onDidChangeStatus: Event<KernelStatus>

An event emitted when the kernel status changes.

`Readonly`status

status: KernelStatus

The current status of the kernel.

Methods

executeCode

executeCode(code: string, token: CancellationToken): AsyncIterable<Output>
Executes code in the kernel without affecting the execution count & execution history.
Parameters
- code: string
  Code to be executed.
- token: CancellationToken
  Triggers the cancellation of the execution.
Returns AsyncIterable<Output>
Async iterable of outputs, that completes when the execution is complete.
- Defined in src/types/jupyter.api.d.ts:97