Class BaseSettings<T>

Base settings specified by a JSON schema.

Type Parameters

T extends IProperty = IProperty

Hierarchy (view full)

BaseSettings
- Settings

Index

Constructors

Properties

Accessors

Methods

default isDefault

Constructors

constructor

new BaseSettings<T>(options): BaseSettings<T>
Type Parameters
- T extends IProperty = IProperty
Parameters
- options: {
  schema: T;
  }
  - schema: T
Returns BaseSettings<T>
- Defined in packages/settingregistry/src/settingregistry.ts:714

Properties

`Private` _schema

_schema: T

Accessors

schema

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

Returns T
- Defined in packages/settingregistry/src/settingregistry.ts:721

Methods

default

default(key?): undefined | PartialJSONValue
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 undefined | PartialJSONValue
A calculated default JSON value for a specific setting.
- Defined in packages/settingregistry/src/settingregistry.ts:754

isDefault

isDefault(user): boolean
Checks if any fields are different from the default value.
Parameters
- user: ReadonlyPartialJSONObject
Returns boolean
- Defined in packages/settingregistry/src/settingregistry.ts:728