Class Settings

constructor

• new Settings(options): Settings

• Instantiate a new plugin settings manager.

  Parameters

  • options: Settings.IOptions

  Returns Settings

Readonly id

Readonly registry

changed

• get changed(): ISignal<this, void>

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

  Returns ISignal<this, void>

composite

• get composite(): ReadonlyPartialJSONObject

• The composite of user settings and extension defaults.

  Returns ReadonlyPartialJSONObject

isDisposed

• get isDisposed(): boolean

• Test whether the plugin settings manager disposed.

  Returns boolean

isModified

• get isModified(): boolean

• Whether the settings have been modified by the user or not.

  Returns boolean

plugin

• get plugin(): IPlugin

• Returns IPlugin

raw

• get raw(): string

• The plugin settings raw text value.

  Returns string

user

• get user(): ReadonlyPartialJSONObject

• The user settings.

  Returns ReadonlyPartialJSONObject

version

• get version(): string

• The published version of the NPM package containing these settings.

  Returns string

annotatedDefaults

• annotatedDefaults(): string

• Return the defaults in a commented JSON format.

  Returns string

dispose

• dispose(): void

• Dispose of the plugin settings resources.

  Returns void

get

• get(key): {
      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.

  Notes

  This method returns synchronously because it uses a cached copy of the plugin settings that is synchronized with the registry.

  • composite: undefined | ReadonlyPartialJSONValue

  • user: undefined | ReadonlyPartialJSONValue

remove

• remove(key): 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.

save

• save(raw): Promise<void>

• Save all of the plugin's user settings at once.

  Parameters

  • raw: string

  Returns Promise<void>

set

• set(key, value): Promise<void>

• Set a single setting.

  Parameters

  • key: string

    The name of the setting being set.
  • value: JSONValue

    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.

validate

• validate(raw): 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.