Interface IOptions

The options object used to initialize a kernel.

interface IOptions {
    clientId?: string;
    handleComms?: boolean;
    model: Kernel.IModel;
    serverSettings?: ServerConnection.ISettings;
    username?: string;
}

Properties

clientId? handleComms? model serverSettings? username?

Properties

Optional clientId

clientId?: string

The unique identifier for the kernel client.

Optional handleComms

handleComms?: boolean

Whether the kernel connection should handle comm messages

Notes

The comm message protocol currently has implicit assumptions that only one kernel connection is handling comm messages. This option allows a kernel connection to opt out of handling comms.

See https://github.com/jupyter/jupyter_client/issues/263

model

model: Kernel.IModel

The kernel model.

Optional serverSettings

serverSettings?: ServerConnection.ISettings

The server settings for the kernel.

Optional username

username?: string

The username of the kernel client.

Settings

Member Visibility

Theme

On This Page

clientIdhandleCommsmodelserverSettingsusername