Clarify that ReactPerf.getLastMeasurements() is now opaque
Dan Abramov committed
Apr 4, 2016 at 16:29 UTC
30dc842e346cad7879b7b2ac1cf6f0c1c9234357
1 file changed
+3
-21
docs/docs/10.9-perf.md
+3
-21
@@ -57,24 +57,6 @@ This method has been renamed to `printOperations()` which is described in the pr
57
The above print methods use `Perf.getLastMeasurements()` to pretty-print the result.
58
59
### `Perf.getLastMeasurements()`
60
-Get the measurements array from the last start-stop session. The array contains objects, each of which looks like this:
61
-
62
-```js
63
-{
64
- // The term "inclusive" and "exclusive" are explained below
65
- "exclusive": {},
66
- // '.0.0' is the React ID of the node
67
- "inclusive": {".0.0": 0.0670000008540228, ".0": 0.3259999939473346},
68
- "render": {".0": 0.036999990697950125, ".0.0": 0.010000003385357559},
69
- // Number of instances
70
- "counts": {".0": 1, ".0.0": 1},
71
- // DOM touches
72
- "writes": {},
73
- // Extra debugging info
74
- "displayNames": {
75
- ".0": {"current": "App", "owner": "<root>"},
76
- ".0.0": {"current": "Box", "owner": "App"}
77
- },
78
- "totalTime": 0.48499999684281647
79
-}
80
-```
60
+Get the opaque data structure describing measurements from the last start-stop session. You can save it and pass it to the methods above to analyze past measurements.
61
+
62
+Don't rely on the exact format of the return value because it may change in minor releases. We will update the documentation if the return value format becomes a supported part of the public API.