[**@jupyterlite**](../../../README.md)

***

[@jupyterlite](../../../README.md) / [@jupyterlite/services](../README.md) / IKernel

# Interface: IKernel

Defined in: [packages/services/src/kernel/tokens.ts:67](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L67)

An interface for a kernel running in the browser.

## Extends

- `IObservableDisposable`

## Properties

### disposed

> `readonly` **disposed**: `ISignal`\<`IKernel`, `void`\>

Defined in: node\_modules/@lumino/disposable/types/index.d.ts:37

A signal emitted when the object is disposed.

#### Inherited from

`IObservableDisposable.disposed`

***

### id

> `readonly` **id**: `string`

Defined in: [packages/services/src/kernel/tokens.ts:71](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L71)

The id of the server-side kernel.

***

### isDisposed

> `readonly` **isDisposed**: `boolean`

Defined in: node\_modules/@lumino/disposable/types/index.d.ts:16

Test whether the object has been disposed.

#### Notes
This property is always safe to access.

#### Inherited from

`IObservableDisposable.isDisposed`

***

### location

> `readonly` **location**: `string`

Defined in: [packages/services/src/kernel/tokens.ts:81](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L81)

The location in the virtual filesystem from which the kernel was started.

***

### name

> `readonly` **name**: `string`

Defined in: [packages/services/src/kernel/tokens.ts:76](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L76)

The name of the server-side kernel.

***

### ready

> `readonly` **ready**: `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/tokens.ts:86](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L86)

A promise that is fulfilled when the kernel is ready.

## Methods

### dispose()

> **dispose**(): `void`

Defined in: node\_modules/@lumino/disposable/types/index.d.ts:28

Dispose of the resources held by the object.

#### Notes
If the object's `dispose` method is called more than once, all
calls made after the first will be a no-op.

#### Undefined Behavior
It is undefined behavior to use any functionality of the object
after it has been disposed unless otherwise explicitly noted.

#### Returns

`void`

#### Inherited from

`IObservableDisposable.dispose`

***

### handleMessage()

> **handleMessage**(`msg`): `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/tokens.ts:93](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/tokens.ts#L93)

Handle an incoming message from the client.

#### Parameters

##### msg

`IMessage`

The message to handle

#### Returns

`Promise`\<`void`\>