A signal emitted for any kernel message.
Note: The behavior is undefined if the message is modified during message handling. As such, it should be treated as read-only.
Unique id of the session.
A signal emitted for iopub kernel messages.
Test whether the object has been disposed.
This property is always safe to access.
The kernel.
This is a read-only property, and can be altered by [changeKernel].
A signal emitted when the kernel changes.
The model associated with the session.
The current name associated with the session.
The current path associated with the session.
A signal emitted when a session property changes.
The server settings of the session.
The current status of the session.
This is a delegate to the kernel status.
A signal emitted when the session status changes.
A signal emitted when the session is shut down.
The type of the session.
A signal emitted for unhandled kernel message.
Change the kernel.
The name or id of the new kernel.
A promise that resolves with the new kernel model.
This shuts down the existing kernel and creates a new kernel, keeping the existing session ID and path.
Dispose of the resources held by the object.
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Change the session name.
Change the session path.
The new session path.
A promise that resolves when the session has renamed.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Change the session type.
Kill the kernel and shutdown the session.
A promise that resolves when the session is shut down.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Generated using TypeDoc
Interface of a session object.