Skip to content

oracular / RevealOptions

Interface: RevealOptions ​

Defined in: types.ts:12

Options that decide when shouldReveal fires and how long cooldowns last. Resolved per call → intent → engine → defaults.

Example ​

ts
shouldReveal(state, 'upgrade', Date.now(), { threshold: 0.7, z: 1.64 });

Extended by ​

Properties ​

PropertyTypeDescriptionDefined in
bound?"normal" | "exact"How lower is computed. 'normal' (default): p − z·sd, clamped to [0, 1]. 'exact': the Beta distribution's own quantile at the same one-sided level, Φ(−z), so z keeps its meaning. The two differ on thin evidence near the threshold, where the approximation is optimistic; under 'exact', z: 0 is the median rather than the mean.types.ts:25
cooldown?numberHow long after markRevealed the intent stays revealed and shouldReveal is false. Default: the intent's halfLife.types.ts:18
threshold?numberProbability the intent must reach, in [0, 1]. Default 0.5.types.ts:14
z?numberHow many standard deviations below p must still clear the threshold. Default 1.28 (one-sided 90%).types.ts:16

Released under the MIT License.