useNativeTokenAmountFromNumber()
Call Signature
function useNativeTokenAmountFromNumber<TUse>(number, options?): When<TUse, DenominatedNumber, Promise<DenominatedNumber>>;
Defined in: packages/react/src/hooks/use-native-token-amount.ts:101
Hook for returning the native token amount from a number value
Type Parameters
| Type Parameter | Default type |
|---|---|
TUse extends boolean | true |
Parameters
| Parameter | Type | Description |
|---|---|---|
number | string | number | The number value |
options? | Partial<ChainOptions<string | number | undefined>> & SuspenseOptions<TUse> | Additional options |
Returns
When<TUse, DenominatedNumber, Promise<DenominatedNumber>>
The native token amount
Call Signature
function useNativeTokenAmountFromNumber<TUse>(options?): When<TUse, (number) => DenominatedNumber, Promise<(number) => DenominatedNumber>>;
Defined in: packages/react/src/hooks/use-native-token-amount.ts:112
Hook for returning a function that converts number value to native token amount
Type Parameters
| Type Parameter | Default type |
|---|---|
TUse extends boolean | true |
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | Partial<ChainOptions<string | number | undefined>> & SuspenseOptions<TUse> | Additional options |
Returns
When<TUse, (number) => DenominatedNumber, Promise<(number) => DenominatedNumber>>
Function for getting the native token amount from a number value