useSpendableBalance

Callable

• useSpendableBalance<TDefer>(address: Address, options?: Options<TDefer>): true extends TDefer ? DenominatedNumber | undefined : DenominatedNumber
• useSpendableBalance<TDefer>(addresses: Address[], options?: Options<TDefer>): true extends TDefer ? DenominatedNumber[] | undefined : DenominatedNumber[]

---

• Hook for getting an account's spendable balance.

  ---

  Type parameters

  • TDefer: boolean = false

  Parameters

  • address: Address

    The account's address

  • optionaloptions: Options<TDefer>

    Additional options

  Returns true extends TDefer ? DenominatedNumber | undefined : DenominatedNumber

  The account's spendable balance