src/vs/base/common/observableInternal/observables/derived.ts
194 LOC · 148 covered · 46 uncovered · 15 ranges · 6771 concepts · 8 introducers · 3467 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.
1
>
/*---------------------------------------------------------------------------------------------
devToolsLogger.ts ×24
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { IObservable, IReader, ITransaction, ISettableObservable, IObservableWithChange } from '../base.js';
7
>
import { IChangeTracker } from '../changeTracker.js';
8
>
import { DisposableStore, EqualityComparer, IDisposable, strictEquals } from '../commonFacade/deps.js';
9
>
import { DebugLocation } from '../debugLocation.js';
10
>
import { DebugOwner, DebugNameData, IDebugNameData } from '../debugName.js';
11
>
import { _setDerivedOpts } from './baseObservable.js';
12
>
import { IDerivedReader, Derived, DerivedWithSetter } from './derivedImpl.js';
13
>
14
>
/**
15
>
* Creates an observable that is derived from other observables.
16
>
* The value is only recomputed when absolutely needed.
17
>
*
18
>
* {@link computeFn} should start with a JS Doc using `@description` to name the derived.
19
>
*/
20
>
export function derived<T, TChange = void>(computeFn: (reader: IDerivedReader<TChange>, debugLocation?: DebugLocation) => T): IObservableWithChange<T, TChange>;
21
>
export function derived<T, TChange = void>(owner: DebugOwner, computeFn: (reader: IDerivedReader<TChange>) => T, debugLocation?: DebugLocation): IObservableWithChange<T, TChange>;
22
>
export function derived<T, TChange = void>(
24
>
computeFn?: ((reader: IDerivedReader<TChange>) => T) | undefined,
25
>
debugLocation = DebugLocation.ofCaller()
26
>
): IObservable<T> {
27
>
if (computeFn !== undefined) {
29
>
new DebugNameData(computeFnOrOwner, undefined, computeFn),
30
>
computeFn,
31
>
undefined,
32
>
undefined,
33
>
strictEquals,
34
>
debugLocation,
35
>
);
36
>
}
38
>
// eslint-disable-next-line local/code-no-any-casts
39
>
new DebugNameData(undefined, undefined, computeFnOrOwner as any),
40
>
// eslint-disable-next-line local/code-no-any-casts
41
>
computeFnOrOwner as any,
42
>
undefined,
43
>
undefined,
44
>
strictEquals,
45
>
debugLocation,
46
>
);
47
>
}
49
>
export function derivedWithSetter<T>(owner: DebugOwner | undefined, computeFn: (reader: IReader) => T, setter: (value: T, transaction: ITransaction | undefined) => void, debugLocation = DebugLocation.ofCaller()): ISettableObservable<T> {
50
return new DerivedWithSetter(
51
new DebugNameData(owner, undefined, computeFn),
52
computeFn,
53
undefined,
54
undefined,
55
strictEquals,
56
setter,
57
debugLocation
58
);
59
}
61
>
export function derivedOpts<T>(
63
>
equalsFn?: EqualityComparer<T>;
64
>
onLastObserverRemoved?: (() => void);
65
>
},
66
>
computeFn: (reader: IReader) => T,
67
>
debugLocation = DebugLocation.ofCaller()
68
>
): IObservable<T> {
69
>
return new Derived(
70
>
new DebugNameData(options.owner, options.debugName, options.debugReferenceFn),
71
>
computeFn,
72
>
undefined,
73
>
options.onLastObserverRemoved,
74
>
options.equalsFn ?? strictEquals,
75
>
debugLocation
76
>
);
77
>
}
79
>
80
>
/**
81
>
* Represents an observable that is derived from other observables.
82
>
* The value is only recomputed when absolutely needed.
83
>
*
84
>
* {@link computeFn} should start with a JS Doc using `@description` to name the derived.
85
>
*
86
>
* Use `createEmptyChangeSummary` to create a "change summary" that can collect the changes.
87
>
* Use `handleChange` to add a reported change to the change summary.
88
>
* The compute function is given the last change summary.
89
>
* The change summary is discarded after the compute function was called.
90
>
*
91
>
* @see derived
92
>
*/
93
>
export function derivedHandleChanges<T, TDelta, TChangeSummary>(
95
>
changeTracker: IChangeTracker<TChangeSummary>;
96
>
equalityComparer?: EqualityComparer<T>;
97
>
},
98
>
computeFn: (reader: IDerivedReader<TDelta>, changeSummary: TChangeSummary) => T,
99
>
debugLocation = DebugLocation.ofCaller()
100
>
): IObservableWithChange<T, TDelta> {
101
>
return new Derived(
102
>
new DebugNameData(options.owner, options.debugName, undefined),
103
>
computeFn,
104
>
options.changeTracker,
105
>
undefined,
106
>
options.equalityComparer ?? strictEquals,
107
>
debugLocation
108
>
);
109
>
}
111
>
/**
112
>
* @deprecated Use `derived(reader => { reader.store.add(...) })` instead!
113
>
*/
114
>
export function derivedWithStore<T>(computeFn: (reader: IReader, store: DisposableStore) => T): IObservable<T>;
115
>
116
>
/**
117
>
* @deprecated Use `derived(reader => { reader.store.add(...) })` instead!
118
>
*/
119
>
export function derivedWithStore<T>(owner: DebugOwner, computeFn: (reader: IReader, store: DisposableStore) => T): IObservable<T>;
120
>
export function derivedWithStore<T>(computeFnOrOwner: ((reader: IReader, store: DisposableStore) => T) | DebugOwner, computeFnOrUndefined?: ((reader: IReader, store: DisposableStore) => T), debugLocation = DebugLocation.ofCaller()): IObservable<T> {
121
let computeFn: (reader: IReader, store: DisposableStore) => T;
122
let owner: DebugOwner;
123
if (computeFnOrUndefined === undefined) {
124
// eslint-disable-next-line local/code-no-any-casts
125
computeFn = computeFnOrOwner as any;
126
owner = undefined;
127
} else {
128
owner = computeFnOrOwner;
129
// eslint-disable-next-line local/code-no-any-casts
130
computeFn = computeFnOrUndefined as any;
131
}
132
133
// Intentionally re-assigned in case an inactive observable is re-used later
134
// eslint-disable-next-line local/code-no-potentially-unsafe-disposables
135
let store = new DisposableStore();
136
137
return new Derived(
138
new DebugNameData(owner, undefined, computeFn),
139
r => {
140
if (store.isDisposed) {
141
store = new DisposableStore();
142
} else {
143
store.clear();
144
}
145
return computeFn(r, store);
146
},
147
undefined,
148
() => store.dispose(),
149
strictEquals,
150
debugLocation
151
);
152
}
154
>
export function derivedDisposable<T extends IDisposable | undefined>(computeFn: (reader: IReader) => T): IObservable<T>;
155
>
export function derivedDisposable<T extends IDisposable | undefined>(owner: DebugOwner, computeFn: (reader: IReader) => T): IObservable<T>;
156
>
export function derivedDisposable<T extends IDisposable | undefined>(computeFnOrOwner: ((reader: IReader) => T) | DebugOwner, computeFnOrUndefined?: ((reader: IReader) => T), debugLocation = DebugLocation.ofCaller()): IObservable<T> {
158
>
let owner: DebugOwner;
159
>
if (computeFnOrUndefined === undefined) {
160
>
// eslint-disable-next-line local/code-no-any-casts
161
>
computeFn = computeFnOrOwner as any;
162
>
owner = undefined;
163
>
} else {
164
owner = computeFnOrOwner;
165
// eslint-disable-next-line local/code-no-any-casts
166
computeFn = computeFnOrUndefined as any;
167
}
169
>
let store: DisposableStore | undefined = undefined;
170
>
return new Derived(
171
>
new DebugNameData(owner, undefined, computeFn),
172
>
r => {
173
>
if (!store) {
174
>
store = new DisposableStore();
175
>
} else {
177
>
}
179
>
if (result) {
180
>
store.add(result);
181
>
}
182
>
return result;
183
>
},
184
>
undefined,
185
>
() => {
186
>
if (store) {
187
>
store.dispose();
188
>
store = undefined;
189
>
}
190
>
},
191
>
strictEquals,
192
>
debugLocation
193
>
);
194
>
}