Interface ISettings<O>

An interface for manipulating the settings of a specific plugin.

interface ISettings<
    O extends ReadonlyPartialJSONObject = ReadonlyPartialJSONObject,
> {
    changed: ISignal<ISettingRegistry.ISettings<O>, void>;
    composite: O;
    id: string;
    isDisposed: boolean;
    plugin: ISettingRegistry.IPlugin;
    raw: string;
    schema: ISchema;
    user: O;
    version: string;
    annotatedDefaults(): string;
    default(key: string): undefined | PartialJSONValue;
    dispose(): void;
    get(
        key: string,
    ): {
        composite: undefined | ReadonlyPartialJSONValue;
        user: undefined | ReadonlyPartialJSONValue;
    };
    remove(key: string): Promise<void>;
    save(raw: string): Promise<void>;
    set(key: string, value: PartialJSONValue): Promise<void>;
    validate(raw: string): null | ISchemaValidator.IError[];
}

Index

Properties

changed composite id isDisposed plugin raw schema user version

Methods

annotatedDefaults default dispose get remove save set validate

Properties

`Readonly`changed

changed: ISignal<ISettingRegistry.ISettings<O>, void>

A signal that emits when the plugin's settings have changed.

`Readonly`composite

composite: O

The composite of user settings and extension defaults.

`Readonly`id

id: string

The plugin's ID.

`Readonly`isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly`plugin

plugin: ISettingRegistry.IPlugin

`Readonly`raw

raw: string

The plugin settings raw text value.

`Readonly`schema

schema: ISchema

The plugin's schema.

`Readonly`user

user: O

The user settings.

`Readonly`version

version: string

The published version of the NPM package containing these settings.

Methods

annotatedDefaults

annotatedDefaults(): string
Return the defaults in a commented JSON format.

Returns string
- Defined in packages/settingregistry/src/tokens.ts:543

default

default(key: string): undefined | PartialJSONValue
Calculate the default value of a setting by iterating through the schema.
Parameters
- key: string
  The name of the setting whose default value is calculated.
Returns undefined | PartialJSONValue
A calculated default JSON value for a specific setting.
- Defined in packages/settingregistry/src/tokens.ts:552

dispose

dispose(): void
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 IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

get

get(
    key: string,
): {
    composite: undefined | ReadonlyPartialJSONValue;
    user: undefined | ReadonlyPartialJSONValue;
}
Get an individual setting.
Parameters
- key: string
  The name of the setting being retrieved.
Returns {
composite: undefined | ReadonlyPartialJSONValue;
user: undefined | ReadonlyPartialJSONValue;
}
The setting value.
- Defined in packages/settingregistry/src/tokens.ts:561

remove

remove(key: string): Promise<void>
Remove a single setting.
Parameters
- key: string
  The name of the setting being removed.
Returns Promise<void>
A promise that resolves when the setting is removed.

Notes
This function is asynchronous because it writes to the setting registry.
- Defined in packages/settingregistry/src/tokens.ts:576

save

save(raw: string): Promise<void>
Save all of the plugin's user settings at once.
Parameters
- raw: string
Returns Promise<void>
- Defined in packages/settingregistry/src/tokens.ts:581

set

set(key: string, value: PartialJSONValue): Promise<void>
Set a single setting.
Parameters
- key: string
  The name of the setting being set.
- value: PartialJSONValue
  The value of the setting.
Returns Promise<void>
A promise that resolves when the setting has been saved.

Notes
This function is asynchronous because it writes to the setting registry.
- Defined in packages/settingregistry/src/tokens.ts:595

validate

validate(raw: string): null | ISchemaValidator.IError[]
Validates raw settings with comments.
Parameters
- raw: string
  The JSON with comments string being validated.
Returns null | ISchemaValidator.IError[]
A list of errors or null if valid.
- Defined in packages/settingregistry/src/tokens.ts:604

Interface ISettings<O>

Type Parameters

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonlychanged

Readonlycomposite

Readonlyid

ReadonlyisDisposed

Notes

Readonlyplugin

Readonlyraw

Readonlyschema

Readonlyuser

Readonlyversion

Methods

annotatedDefaults

Returns string

default

Parameters

Returns undefined | PartialJSONValue

dispose

Notes

Undefined Behavior

Returns void

get

Parameters

Returns { composite: undefined | ReadonlyPartialJSONValue; user: undefined | ReadonlyPartialJSONValue;}

remove

Parameters

Returns Promise<void>

Notes

save

Parameters

Returns Promise<void>

set

Parameters

Returns Promise<void>

Notes

validate

Parameters

Returns null | ISchemaValidator.IError[]

Settings

On This Page

`Readonly`changed

`Readonly`composite

`Readonly`id

`Readonly`isDisposed

`Readonly`plugin

`Readonly`raw

`Readonly`schema

`Readonly`user

`Readonly`version

Returns {
composite: undefined | ReadonlyPartialJSONValue;
user: undefined | ReadonlyPartialJSONValue;
}