# Interface: `ISettings`

[@jupyterlite/settings](../modules/jupyterlite_settings.md).ISettings

The interface for the Settings service.

## Properties

### `ready`

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

A promise that resolves after the settings have been full initialized

#### Defined in

[packages/settings/src/tokens.ts:47](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/settings/src/tokens.ts#L47)

## Methods

### `get`

> **`get`**(`pluginId`): `Promise`<`undefined` \|
> [`IPlugin`](jupyterlite_settings.IPlugin.md)\>

Get settings by plugin id

#### Parameters

| Name       | Type     | Description          |
| :--------- | :------- | :------------------- |
| `pluginId` | `string` | the id of the plugin |

#### Returns

`Promise`<`undefined` \| [`IPlugin`](jupyterlite_settings.IPlugin.md)\>

#### Defined in

[packages/settings/src/tokens.ts:55](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/settings/src/tokens.ts#L55)

### `getAll`

> **`getAll`**(): `Promise`<{ `settings`: [`IPlugin`](jupyterlite_settings.IPlugin.md)[]
> }\>

Get all the settings

#### Returns

`Promise`<{ `settings`: [`IPlugin`](jupyterlite_settings.IPlugin.md)[] }\>

#### Defined in

[packages/settings/src/tokens.ts:60](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/settings/src/tokens.ts#L60)

### `save`

> **`save`**(`pluginId`, `raw`): `Promise`<`void`\>

Save settings for a given plugin id

#### Parameters

| Name       | Type     | Description          |
| :--------- | :------- | :------------------- |
| `pluginId` | `string` | The id of the plugin |
| `raw`      | `string` | The raw settings     |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/settings/src/tokens.ts:69](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/settings/src/tokens.ts#L69)