Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SectionPreferenceProvider Abstract

This class encapsulates the logic of using separate files for some workspace configuration like 'launch.json' or 'tasks.json'. Anything that is not a contributed section will be in the main config file.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _fileExists

_fileExists: boolean = false

Private Optional _isSection

_isSection?: boolean

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected Readonly fileService

fileService: FileService

Protected Readonly loading

loading: Deferred<void> = ...

Protected Readonly onDidChangeValidityEmitter

onDidChangeValidityEmitter: Emitter<boolean> = ...

Protected Readonly preferenceConfigurations

preferenceConfigurations: PreferenceConfigurations

Protected preferences

preferences: Record<string, any> = {}

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected Readonly section

section: string

Protected transaction

transaction: undefined | PreferenceTransaction

Protected Readonly transactionFactory

transactionFactory: PreferenceTransactionFactory

Protected Readonly uri

uri: URI

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

fileExists

  • set fileExists(exists: boolean): void

Private isSection

  • get isSection(): boolean

onDidChangeValidity

  • get onDidChangeValidity(): Event<boolean>

valid

  • get valid(): boolean

Methods

contains

  • contains(resourceUri: undefined | string): boolean

Protected doInit

  • doInit(): Promise<void>

Protected doSetPreference

  • doSetPreference(key: string, path: string[], value: unknown): Promise<boolean>

getConfigUri

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

Protected getPath

  • getPath(preferenceName: string): undefined | string[]

getPreferences

  • getPreferences(resourceUri?: string): {}

Abstract getScope

  • getScope(): PreferenceScope

Protected getUri

  • getUri(): URI

Protected handlePreferenceChanges

  • handlePreferenceChanges(newPrefs: {}): void

Protected init

  • init(): void

Protected parse

  • parse(content: string): any

Protected readPreferencesFromContent

  • readPreferencesFromContent(content: string): void

Protected readPreferencesFromFile

  • readPreferencesFromFile(): Promise<void>

Protected reset

  • reset(): void

setPreference

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

Protected toFileManager