Base settings specified by a JSON schema.

Type Parameters

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

  • Type Parameters

    Parameters

    • options: {
          schema: T;
      }
      • schema: T

    Returns BaseSettings<T>

Properties

_schema: any

Accessors

  • get schema(): T
  • The plugin's schema.

    Returns T

Methods

  • Calculate the default value of a setting by iterating through the schema.

    Parameters

    • Optional key: string

      The name of the setting whose default value is calculated.

    Returns PartialJSONValue

    A calculated default JSON value for a specific setting.

  • Checks if any fields are different from the default value.

    Parameters

    Returns boolean

Generated using TypeDoc