git-watchtower 2.3.20 → 2.3.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/state/store.js +35 -3
package/package.json
CHANGED
package/src/state/store.js
CHANGED
|
@@ -209,15 +209,47 @@ class Store {
|
|
|
209
209
|
}
|
|
210
210
|
|
|
211
211
|
/**
|
|
212
|
-
* Get a
|
|
212
|
+
* Get a snapshot of the current state.
|
|
213
|
+
*
|
|
214
|
+
* The top-level object is a shallow copy (so adding/removing top-level
|
|
215
|
+
* keys on the returned object does not mutate the store). Map values
|
|
216
|
+
* (sparklineCache, branchPrStatusMap, aheadBehindCache) are also
|
|
217
|
+
* shallow-cloned so that consumers — most importantly the web
|
|
218
|
+
* dashboard's getSerializableState — can iterate or mutate the
|
|
219
|
+
* snapshot without the store's live data shifting underneath them.
|
|
220
|
+
*
|
|
221
|
+
* If you need the live, by-reference Map for in-place mutation
|
|
222
|
+
* followed by setState() (the polling cache-prune pattern), use
|
|
223
|
+
* `get(key)` instead.
|
|
224
|
+
*
|
|
213
225
|
* @returns {State}
|
|
214
226
|
*/
|
|
215
227
|
getState() {
|
|
216
|
-
|
|
228
|
+
const snapshot = { ...this.state };
|
|
229
|
+
if (snapshot.sparklineCache instanceof Map) {
|
|
230
|
+
snapshot.sparklineCache = new Map(snapshot.sparklineCache);
|
|
231
|
+
}
|
|
232
|
+
if (snapshot.branchPrStatusMap instanceof Map) {
|
|
233
|
+
snapshot.branchPrStatusMap = new Map(snapshot.branchPrStatusMap);
|
|
234
|
+
}
|
|
235
|
+
if (snapshot.aheadBehindCache instanceof Map) {
|
|
236
|
+
snapshot.aheadBehindCache = new Map(snapshot.aheadBehindCache);
|
|
237
|
+
}
|
|
238
|
+
return snapshot;
|
|
217
239
|
}
|
|
218
240
|
|
|
219
241
|
/**
|
|
220
|
-
* Get a specific state value
|
|
242
|
+
* Get a specific state value by-reference.
|
|
243
|
+
*
|
|
244
|
+
* IMPORTANT: returns the live value, not a copy. For Map values
|
|
245
|
+
* (sparklineCache, branchPrStatusMap, aheadBehindCache) this is
|
|
246
|
+
* deliberate — the polling layer mutates these in place and then
|
|
247
|
+
* calls setState({key: sameMap}) to notify subscribers. Code that
|
|
248
|
+
* doesn't intend to mutate should treat the result as read-only,
|
|
249
|
+
* or copy it first (e.g. `new Map(store.get('sparklineCache'))`).
|
|
250
|
+
*
|
|
251
|
+
* For an isolation-safe snapshot, prefer `getState()`.
|
|
252
|
+
*
|
|
221
253
|
* @template {keyof State} K
|
|
222
254
|
* @param {K} key - State key
|
|
223
255
|
* @returns {State[K]}
|