useSpendableBalance()
function useSpendableBalance<TUse>(address, options?): When<TUse, DenominatedNumber, Promise<DenominatedNumber>>;
Defined in: packages/react/src/hooks/use-balance.ts:45
Hook for getting an account's spendable balance.
Type Parameters
| Type Parameter | Default type |
|---|---|
TUse extends boolean | true |
Parameters
| Parameter | Type | Description |
|---|---|---|
address | Address | The account's address |
options? | Options<TUse> | Additional options |
Returns
When<TUse, DenominatedNumber, Promise<DenominatedNumber>>
The account's spendable balance