assertClickBudgetsFitTransportCap

Refuses a settle/result budget pair that a single transport call could never honour.

clickButton waits for the button to mount and then for its result INSIDE ONE evalInObsidian closure, so the transport’s script timeout bounds their sum rather than either one alone — and RegisterDemoVaultButtonSuiteOptions lets a consumer raise each independently, with nothing summing them. Raising settleTimeoutInMilliseconds to 20 000 for one slow note is an ordinary thing to do and silently puts the pair at the cap.

Throwing here, at suite registration, is the whole value: the failure it replaces is a WebDriverError: script timeout raised mid-run against whichever button happened to be slowest, naming the transport and neither budget.

Import:

import { assertClickBudgetsFitTransportCap } from 'obsidian-dev-utils/script-utils/demo-vault-buttons';

Signature:

function assertClickBudgetsFitTransportCap(timeouts: ClickButtonTimeouts): void

Parameters:

Parameter	Type	Description
timeouts	ClickButtonTimeouts	The ClickButtonTimeouts to bound.

Returns: void

---

Links to this page:

• ClickButtonTimeouts