Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkspaceFilePreferenceProviderWithExtensions

Hierarchy

  • WorkspaceFilePreferenceProvider
    • WorkspaceFilePreferenceProviderWithExtensions

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _pendingChanges

_pendingChanges: Promise<boolean>

Protected Readonly _ready

_ready: Deferred<void>

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

Protected Readonly fileService

fileService: FileService

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: () => Promise<boolean>

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

Protected Readonly loading

loading: Deferred<unknown>

Protected Readonly messageService

messageService: MessageService

Protected model

model: undefined | MonacoEditorModel

Protected modelInitialized

modelInitialized: boolean

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges>

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges>

Protected Readonly options

options: WorkspaceFilePreferenceProviderOptions

Protected Readonly preferenceOverrideService

preferenceOverrideService: PreferenceLanguageOverrideService

Protected preferences

preferences: {}

Type declaration

  • [key: string]: any

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected sectionsInsideSettings

sectionsInsideSettings: Set<string>

Protected Readonly textModelService

textModelService: MonacoTextModelService

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly workspace

workspace: MonacoWorkspace

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

pendingChanges

  • get pendingChanges(): Promise<boolean>

  • Returns Promise<boolean>

ready

  • get ready(): Promise<void>

  • Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

    Returns Promise<void>

Protected valid

  • get valid(): boolean

  • Returns boolean

Methods

Protected belongsInSection

  • belongsInSection(firstSegment: string, remainder: string): boolean

contains

  • contains(resourceUri: undefined | string): boolean

  • Parameters

    • resourceUri: undefined | string

    Returns boolean

dispose

  • dispose(): void

  • Returns void

Protected emitPreferencesChangedEvent

  • emitPreferencesChangedEvent(changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]): Promise<boolean>

  • Informs the listeners that one or more preferences of this provider are changed. The listeners are able to find what was changed from the emitted event.

    Parameters

    • changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]

    Returns Promise<boolean>

get

  • get<T>(preferenceName: string, resourceUri?: string): undefined | T

  • Retrieve the stored value for the given preference and resource URI.

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: string

      the uri of the resource for which the preference is stored. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

    Returns undefined | T

    the value stored for the given preference and resourceUri if it exists, otherwise undefined.

getConfigUri

  • getConfigUri(): default
  • getConfigUri(resourceUri: undefined | string): undefined | default

  • Returns default

  • Parameters

    • resourceUri: undefined | string

    Returns undefined | default

Optional getContainingConfigUri

  • getContainingConfigUri(resourceUri?: string, sectionName?: string): undefined | default

  • Retrieves the first valid configuration URI contained by the given resource.

    Parameters

    • Optional resourceUri: string

      the uri of the container resource or undefined.

    • Optional sectionName: string

    Returns undefined | default

    the first valid configuration URI contained by the given resource undefined if there is no valid configuration URI at all.

getDomain

  • getDomain(): string[]

  • Returns string[]

Protected getParsedContent

  • getParsedContent(jsonData: any): {}

  • Parameters

    • jsonData: any

    Returns {}

    • [key: string]: any

Protected getPath

  • getPath(preferenceName: string): string[]

  • Parameters

    • preferenceName: string

    Returns string[]

getPreferences

  • getPreferences(resourceUri?: string): {}

  • Parameters

    • Optional resourceUri: string

    Returns {}

    • [key: string]: any

Protected getScope

  • getScope(): PreferenceScope

  • Returns PreferenceScope

Protected getUri

  • getUri(): default

  • Returns default

Protected handlePreferenceChanges

  • handlePreferenceChanges(newPrefs: {}): void

  • Parameters

    • newPrefs: {}
      • [key: string]: any

    Returns void

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

Protected mergePreferenceProviderDataChange

  • mergePreferenceProviderDataChange(change: PreferenceProviderDataChange): void

  • Parameters

    • change: PreferenceProviderDataChange

    Returns void

Protected parse

  • parse(content: string): any

  • Parameters

    • content: string

    Returns any

Protected readPreferences

  • readPreferences(): void

  • It HAS to be sync to ensure that setPreference returns only when values are updated or any other operation modifying the monaco model content.

    Returns void

Protected readPreferencesFromContent

  • readPreferencesFromContent(content: string): void

  • Parameters

    • content: string

    Returns void

Protected readPreferencesFromFile

  • readPreferencesFromFile(): Promise<void>

  • Returns Promise<void>

Protected reset

  • reset(): void

  • Returns void

resolve

  • resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T>

  • Resolve the value for the given preference and resource URI.

    Type parameters

    • T

    Parameters

    • preferenceName: string

      the preference identifier.

    • Optional resourceUri: string

      the URI of the resource for which this provider should resolve the preference. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

    Returns PreferenceResolveResult<T>

    an object containing the value stored for the given preference and resourceUri if it exists, otherwise undefined.

setPreference

  • setPreference(key: string, value: any, resourceUri?: string): Promise<boolean>

  • Parameters

    • key: string
    • value: any
    • Optional resourceUri: string

    Returns Promise<boolean>

Static deepEqual

  • deepEqual(a: undefined | null | string | number | boolean | JSONObject | JSONArray, b: undefined | null | string | number | boolean | JSONObject | JSONArray): boolean

  • Handles deep equality with the possibility of undefined

    Parameters

    • a: undefined | null | string | number | boolean | JSONObject | JSONArray
    • b: undefined | null | string | number | boolean | JSONObject | JSONArray

    Returns boolean

Static merge

  • merge(source: undefined | null | string | number | boolean | JSONObject | JSONArray, target: JSONValue): JSONValue

  • Parameters

    • source: undefined | null | string | number | boolean | JSONObject | JSONArray
    • target: JSONValue

    Returns JSONValue