IKernelPreference | @jupyterlab

A kernel preference.

Notes

Preferences for a kernel are considered in the order id, name, language. If no matching kernels can be found and autoStartDefault is true, then the default kernel for the server is preferred.

Hierarchy

IKernelPreference

Index

Properties

autoStartDefault
canStart
id
language
name
shouldStart
shutdownOnDispose

Properties

Optional Readonly autoStartDefault

autoStartDefault: boolean

Automatically start the default kernel if no other matching kernel is found (default true).

Optional Readonly canStart

canStart: boolean

A kernel can be started (default true).

Optional Readonly id

id: string

The id of an existing kernel.

Optional Readonly language

language: string

The preferred kernel language.

Optional Readonly name

name: string

The name of the kernel.

Optional Readonly shouldStart

shouldStart: boolean

A kernel should be started automatically (default true).

Optional Readonly shutdownOnDispose

shutdownOnDispose: boolean

Shut down the session when session context is disposed (default false).