Interface IOptions

The session initialization options.

interface IOptions {
    clientId?: string;
    kernelConnectionOptions?: Omit<Kernel.IKernelConnection.IOptions, "serverSettings" | "model" | "username" | "clientId">;
    model: Session.IModel;
    serverSettings?: ServerConnection.ISettings;
    username?: string;
    connectToKernel(options): IKernelConnection;
}

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, "serverSettings" | "model" | "username" | "clientId">

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/src/session/session.ts:196