oracular / shouldReveal

Function: shouldReveal()

function shouldReveal(
   state, 
   intent, 
   at, 
   opts?
): boolean;

Defined in: predict.ts:67

Whether to act on the intent now. True when p ≥ threshold, the lower confidence bound (p − z·sd, or the exact Beta quantile with bound: 'exact') also clears threshold, and no cooldown is running: neither the one started by markRevealed nor the one started by the intent's outcome event.

Parameters

Parameter	Type	Description
state	EngineState	The current state. Not mutated.
intent	string	Name of an intent declared in the config.
at	number	The time to evaluate at.
opts?	RevealOptions	Overrides for threshold (default 0.5), z (default 1.28, a one-sided 90% bound) and cooldown (default: the intent's halfLife).

Returns

boolean

True when the app should show, offer or reveal whatever this intent gates.

Throws

RangeError when intent is not declared in the config.

Throws

TypeError when state is not an engine state, at is not finite, or opts is malformed.

Example

if (shouldReveal(state, 'upgrade', Date.now())) {
  showUpgradeOffer();
  state = markRevealed(state, 'upgrade', Date.now());
}