Skip to content
On this page

Function: readBondNeed()

TypeScript
function readBondNeed(need: unknown): BondNeed | null;

Defined in: auth-core/src/index.ts:252 (opens in a new tab)

need when it is a floor bondMeets can apply, else null: an object of minSats, minDays and maxAgeSecs only, each left out or a whole number of 0 or more (a safe integer). NaN, a string, a fraction or a misspelt key is no floor at all, so it never reads as 0.

ParametersLink to this section

ParameterType
needunknown

ReturnsLink to this section

BondNeed | null