Class BaseSettings<T>

Base settings specified by a JSON schema.

Type Parameters

T extends IProperty = IProperty

Hierarchy (View Summary)

BaseSettings
- Settings

Index

Constructors

Accessors

Methods

default isDefault

Constructors

constructor

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

Accessors

schema

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

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

Methods

default

default(key?: string): undefined | PartialJSONValue
Calculate the default value of a setting by iterating through the schema.
Parameters
- Optionalkey: 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:761

isDefault

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