Interface ISettings

Readonly changed

Readonly composite

Readonly id

Readonly plugin

Readonly raw

Readonly schema

Readonly user

Readonly version

annotatedDefaults

• annotatedDefaults(): string

• Return the defaults in a commented JSON format.

  Returns string

default

• default(key): 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 PartialJSONValue

  A calculated default JSON value for a specific setting.

get

• get(key): {
      composite: ReadonlyPartialJSONValue;
      user: ReadonlyPartialJSONValue;
  }

• Get an individual setting.

  Parameters

  • key: string

    The name of the setting being retrieved.

  Returns {
      composite: ReadonlyPartialJSONValue;
      user: ReadonlyPartialJSONValue;
  }

  The setting value.

  • composite: ReadonlyPartialJSONValue

  • user: 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: 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.

validate

• validate(raw): ISchemaValidator.IError[]

• Validates raw settings with comments.

  Parameters

  • raw: string

    The JSON with comments string being validated.

  Returns ISchemaValidator.IError[]

  A list of errors or null if valid.