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

***

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

# Class: LiteKernelClient

Defined in: [packages/services/src/kernel/client.ts:35](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L35)

A class to handle requests to /api/kernels

## Implements

- `IKernelAPIClient`

## Constructors

### Constructor

> **new LiteKernelClient**(`options`): `LiteKernelClient`

Defined in: [packages/services/src/kernel/client.ts:41](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L41)

Construct a new Kernels

#### Parameters

##### options

[`IOptions`](../namespaces/LiteKernelClient/interfaces/IOptions.md)

The instantiation options

#### Returns

`LiteKernelClient`

## Accessors

### changed

#### Get Signature

> **get** **changed**(): `ISignal`\<`this`, `IChangedArgs`\<[`IKernel`](../interfaces/IKernel.md)\>\>

Defined in: [packages/services/src/kernel/client.ts:61](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L61)

Signal emitted when the kernels map changes

##### Returns

`ISignal`\<`this`, `IChangedArgs`\<[`IKernel`](../interfaces/IKernel.md)\>\>

***

### serverSettings

#### Get Signature

> **get** **serverSettings**(): `ISettings`

Defined in: [packages/services/src/kernel/client.ts:54](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L54)

The server settings for the kernel client.

##### Returns

`ISettings`

#### Implementation of

`Kernel.IKernelAPIClient.serverSettings`

## Methods

### getModel()

> **getModel**(`id`): `Promise`\<`undefined` \| [`IKernel`](../interfaces/IKernel.md)\>

Defined in: [packages/services/src/kernel/client.ts:390](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L390)

Get a kernel by id

#### Parameters

##### id

`string`

#### Returns

`Promise`\<`undefined` \| [`IKernel`](../interfaces/IKernel.md)\>

#### Implementation of

`Kernel.IKernelAPIClient.getModel`

***

### handleStdin()

> **handleStdin**(`inputRequest`): `Promise`\<`IInputReplyMsg`\>

Defined in: [packages/services/src/kernel/client.ts:397](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L397)

Handle stdin request received from Service Worker.

#### Parameters

##### inputRequest

`IInputRequestMsg`

#### Returns

`Promise`\<`IInputReplyMsg`\>

***

### interrupt()

> **interrupt**(`kernelId`): `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/client.ts:338](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L338)

Interrupt a kernel.

#### Parameters

##### kernelId

`string`

#### Returns

`Promise`\<`void`\>

#### Implementation of

`Kernel.IKernelAPIClient.interrupt`

***

### listRunning()

> **listRunning**(): `Promise`\<`IModel`[]\>

Defined in: [packages/services/src/kernel/client.ts:360](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L360)

List the running kernels.

#### Returns

`Promise`\<`IModel`[]\>

#### Implementation of

`Kernel.IKernelAPIClient.listRunning`

***

### restart()

> **restart**(`kernelId`): `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/client.ts:325](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L325)

Restart a kernel.

#### Parameters

##### kernelId

`string`

The kernel id.

#### Returns

`Promise`\<`void`\>

#### Implementation of

`Kernel.IKernelAPIClient.restart`

***

### shutdown()

> **shutdown**(`id`): `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/client.ts:372](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L372)

Shut down a kernel.

#### Parameters

##### id

`string`

The kernel id.

#### Returns

`Promise`\<`void`\>

#### Implementation of

`Kernel.IKernelAPIClient.shutdown`

***

### shutdownAll()

> **shutdownAll**(): `Promise`\<`void`\>

Defined in: [packages/services/src/kernel/client.ts:381](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L381)

Shut down all kernels.

#### Returns

`Promise`\<`void`\>

***

### startNew()

> **startNew**(`options`): `Promise`\<`IModel`\>

Defined in: [packages/services/src/kernel/client.ts:70](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/kernel/client.ts#L70)

Start a new kernel.

#### Parameters

##### options

[`IKernelOptions`](../namespaces/LiteKernelClient/interfaces/IKernelOptions.md)

The kernel start options.

#### Returns

`Promise`\<`IModel`\>

#### Implementation of

`Kernel.IKernelAPIClient.startNew`