1681-engine / index / FrameSamplerOptions

Interface: FrameSamplerOptions

Defined in: src/diagnostics/FrameSampler.ts:4

Properties

hitchMs?

optional hitchMs?: number;

Defined in: src/diagnostics/FrameSampler.ts:8

A frame longer than this is a hitch, ms (default 50).

---

minFrames?

optional minFrames?: number;

Defined in: src/diagnostics/FrameSampler.ts:10

Fewer frames than this in a window is no sample (default 30).

---

now?

optional now?: () => number;

Defined in: src/diagnostics/FrameSampler.ts:15

Returns

number

---

paused?

optional paused?: () => boolean;

Defined in: src/diagnostics/FrameSampler.ts:14

Frames are not counted while this says so (default: the page is hidden).

Returns

boolean

---

throttledMedianMs?

optional throttledMedianMs?: number;

Defined in: src/diagnostics/FrameSampler.ts:12

A window whose median frame is over this came from a throttled background window and is dropped (default 500).

---

windowMs?

optional windowMs?: number;

Defined in: src/diagnostics/FrameSampler.ts:6

How long one sample spans, ms (default a minute).