Class MockPreferenceService

Service to manage preferences including, among others, getting and setting preference values as well as listening to preference changes.

Depending on your use case you might also want to look at createPreferenceProxy with which you can easily create a typesafe schema-based interface for your preferences. Internally the proxy uses the PreferenceService so both approaches are compatible.

Implements

PreferenceService

Index

Constructors

constructor

new MockPreferenceService(): MockPreferenceService
Returns MockPreferenceService
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:26

Properties

`Readonly` isReady

isReady: true = true

Indicates whether the service has successfully initialized. Will be true when the ready Promise resolves.

`Readonly` onPreferenceChanged

onPreferenceChanged: Event<PreferenceChange> = ...

Registers a callback which will be called whenever a preference is changed.

`Readonly` onPreferencesChanged

onPreferencesChanged: Event<PreferenceChanges> = ...

Registers a callback which will be called whenever one or more preferences are changed.

`Readonly` ready

ready: Promise<void> = ...

Promise indicating whether the service successfully initialized.

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of PreferenceService.dispose
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:27

get

get<T>(preferenceName): undefined | T
Retrieve the stored value for the given preference.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
Returns undefined | T
the value stored for the given preference when it exists, undefined otherwise.
Implementation of PreferenceService.get
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:28
get<T>(preferenceName, defaultValue): T
Retrieve the stored value for the given preference.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- defaultValue: T
  the value to return when no value for the given preference is stored.
Returns T
the value stored for the given preference when it exists, otherwise the given default value.
Implementation of PreferenceService.get
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:29
get<T>(preferenceName, defaultValue, resourceUri): T
Retrieve the stored value for the given preference and resourceUri.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- defaultValue: T
  the value to return when no value for the given preference is stored.
- resourceUri: string
  the uri of the resource for which the preference is stored. This used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.
Returns T
the value stored for the given preference and resourceUri when it exists, otherwise the given default value.
Implementation of PreferenceService.get
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:30

getConfigUri

getConfigUri(scope, resourceUri?): undefined | URI
Returns the uri of the configuration resource for the given scope and optional resource uri.
Parameters
- scope: PreferenceScope
  the PreferenceScope to query for.
- Optional resourceUri: string
  the optional uri of the resource-specific preference handling
Returns undefined | URI
the uri of the configuration resource for the given scope and optional resource uri it it exists, undefined otherwise.
Implementation of PreferenceService.getConfigUri
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:62

inspect

inspect<T>(preferenceName, resourceUri?): undefined | PreferenceInspection<T>
Retrieve the stored value for the given preference and resourceUri in all available scopes.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- Optional resourceUri: string
  the uri of the resource for which the preference is stored.
Returns undefined | PreferenceInspection<T>
an object containing the value of the given preference for all scopes.
Implementation of PreferenceService.inspect
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:40

inspectInScope

inspectInScope<T>(preferenceName, scope, resourceUri?, forceLanguageOverride?): undefined | T
For behavior, see PreferenceService.inspect.
Type Parameters
- T
Parameters
- preferenceName: string
- scope: PreferenceScope
- Optional resourceUri: string
- Optional forceLanguageOverride: boolean
Returns undefined | T
the value in the scope specified.
Implementation of PreferenceService.inspectInScope
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:43

overriddenPreferenceName

overriddenPreferenceName(preferenceName): undefined | OverridePreferenceName
Tries to split the given preference identifier into the original OverridePreferenceName attributes with which this identifier was created. Returns undefined if this is not possible, for example when the given preference identifier was not generated by overridePreferenceName.

This method is checked when resolving preferences. Therefore together with "overridePreferenceName" this can be used to handle specialized preferences, e.g. "[markdown].editor.autoIndent" and "editor.autoIndent".
Parameters
- preferenceName: string
  the preferenceName which might have been created via PreferenceService.overridePreferenceName.
Returns undefined | OverridePreferenceName
the OverridePreferenceName which was used to create the given preferenceName if this was the case, undefined otherwise.
Implementation of PreferenceService.overriddenPreferenceName
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:56

overridePreferenceName

overridePreferenceName(options): string
Returns a new preference identifier based on the given OverridePreferenceName.
Parameters
- options: OverridePreferenceName
  the override specification.
Returns string
the calculated string based on the given OverridePreferenceName.
Implementation of PreferenceService.overridePreferenceName
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:53

resolve

resolve<T>(preferenceName, defaultValue?, resourceUri?): {
configUri?: URI;
value?: T;
}
Retrieve the stored value for the given preference and resourceUri.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- Optional defaultValue: T
  the value to return when no value for the given preference is stored.
- Optional resourceUri: string
  the uri of the resource for which the preference is stored. This used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.
Returns {
configUri?: URI;
value?: T;
}
an object containing the value stored for the given preference and resourceUri when it exists, otherwise the given default value. If determinable the object will also contain the uri of the configuration resource in which the preference was stored.
- Optional configUri?: URI
- Optional value?: T
Implementation of PreferenceService.resolve
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:34

set

set(preferenceName, value): Promise<void>
Sets the given preference to the given value.
Parameters
- preferenceName: string
  the preference identifier.
- value: any
  the new value of the preference.
Returns Promise<void>
a promise which resolves to undefined when setting the preference was successful. Otherwise it rejects with an error.
Implementation of PreferenceService.set
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:47

updateValue

updateValue(): Promise<void>
Determines and applies the changes necessary to apply value to either the resourceUri supplied or the active session. If there is no setting for the preferenceName, the change will be applied in user scope. If there is a setting conflicting with the specified value, the change will be applied in the most specific scope with a conflicting value.

Returns Promise<void>
Implementation of PreferenceService.updateValue
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:48

validate

validate(name, value): boolean
Parameters
- name: string
- value: any
Returns boolean
- Defined in packages/core/src/browser/preferences/test/mock-preference-service.ts:61

Class MockPreferenceService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MockPreferenceService

Properties

Readonly isReady

Readonly onPreferenceChanged

Readonly onPreferencesChanged

Readonly ready

Methods

dispose

Returns void

get

Type Parameters

Parameters

Returns undefined | T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

getConfigUri

Parameters

Returns undefined | URI

inspect

Type Parameters

Parameters

Returns undefined | PreferenceInspection<T>

inspectInScope

Type Parameters

Parameters

Returns undefined | T

overriddenPreferenceName

Parameters

Returns undefined | OverridePreferenceName

overridePreferenceName

Parameters

Returns string

resolve

Type Parameters

Parameters

Returns { configUri?: URI; value?: T; }

Optional configUri?: URI

Optional value?: T

set

Parameters

Returns Promise<void>

updateValue

Returns Promise<void>

validate

Parameters

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Readonly` isReady

`Readonly` onPreferenceChanged

`Readonly` onPreferencesChanged

`Readonly` ready

Returns {
configUri?: URI;
value?: T;
}

`Optional` configUri?: URI

`Optional` value?: T