Interface IOptions

The session initialization options.

Hierarchy

IOptions

Index

Properties

clientId? kernelConnectionOptions? model serverSettings? username?

Methods

connectToKernel

Properties

`Optional` clientId

clientId?: string

The unique identifier for the session client.

`Optional` kernelConnectionOptions

kernelConnectionOptions?: Omit<Kernel.IKernelConnection.IOptions, "username" | "clientId" | "model" | "serverSettings">

Kernel connection options

model

model: Session.IModel

Session model.

`Optional` serverSettings

serverSettings?: ServerConnection.ISettings

The server settings.

`Optional` username

username?: string

The username of the session client.

Methods

connectToKernel

connectToKernel(options): IKernelConnection
Connects to an existing kernel
Parameters
- options: Kernel.IKernelConnection.IOptions
Returns IKernelConnection
- Defined in packages/services/lib/session/session.d.ts:158

Generated using TypeDoc