BaseSettings | @jupyterlab (original) (raw)

Type Parameters

• T extends IProperty = IProperty

Hierarchy (View Summary)

• BaseSettings
  • Settings

Index

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>

Accessors

schema

• get schema(): T

• Returns T

Methods

default

• default(key?: string): undefined | PartialJSONValue

• Parameters

  • Optionalkey: string

Returns undefined | PartialJSONValue

A calculated default JSON value for a specific setting.

isDefault

• isDefault(user: ReadonlyPartialJSONObject): boolean

• Returns boolean