src/vs/platform/observable/common/observableMemento.ts
88 LOC · 73 covered · 15 uncovered · 15 ranges · 852 concepts · 4 introducers · 520 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
observableMemento.ts ×5
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { strictEquals } from '../../../base/common/equals.js';
import { DisposableStore, IDisposable } from '../../../base/common/lifecycle.js';
import { DebugLocation } from '../../../base/common/observable.js';
// eslint-disable-next-line local/code-no-deep-import-of-internal
import { DebugNameData } from '../../../base/common/observableInternal/debugName.js';
// eslint-disable-next-line local/code-no-deep-import-of-internal
import { ObservableValue } from '../../../base/common/observableInternal/observables/observableValue.js';
import { IStorageService, StorageScope, StorageTarget } from '../../storage/common/storage.js';
interface IObservableMementoOpts<T> {
defaultValue: T;
key: string;
toStorage: (value: T) => string;
fromStorage: (value: string) => T;
}
/**
* Defines an observable memento. Returns a function that can be called with
* the specific storage scope, target, and service to use in a class.
*
* Note that the returned Observable is a disposable, because it interacts
* with storage service events, and must be tracked appropriately.
*/
export function observableMemento<T>(opts: IObservableMementoOpts<T>) {
return (scope: StorageScope, target: StorageTarget, storageService: IStorageService): ObservableMemento<T> => {
observableMemento.ts ×2
};
/**
* A value that is stored, and is also observable. Note: T should be readonly.
*/
export class ObservableMemento<T> extends ObservableValue<T> implements IDisposable {
private readonly _store = new DisposableStore();
private _noStorageUpdateNeeded = false;
constructor(
private readonly storageScope: StorageScope,
private readonly storageTarget: StorageTarget,
@IStorageService private readonly storageService: IStorageService,
) {
const getStorageValue = (): T => {
const fromStorage = storageService.get(opts.key, storageScope);
if (fromStorage !== undefined) {
try {
return opts.fromStorage(fromStorage);
} catch {
return opts.defaultValue;
}
}
};
const initialValue = getStorageValue();
super(new DebugNameData(undefined, `storage/${opts.key}`, undefined), initialValue, strictEquals, DebugLocation.ofCaller());
const didChange = storageService.onDidChangeValue(storageScope, opts.key, this._store);
this._store.add(didChange((e) => {
this._noStorageUpdateNeeded = true;
try {
this.set(getStorageValue(), undefined);
} finally {
this._noStorageUpdateNeeded = false;
}
}
}
protected override _setValue(newValue: T): void {
if (this._noStorageUpdateNeeded) {
return;
}
this.storageService.store(this.opts.key, valueToStore, this.storageScope, this.storageTarget);
}
dispose(): void {
}