Reactive

Appearance

useBalance ​

Composable for fetching the AE balance of an address.

Import ​

typescript
import { useBalance } from '@growae/reactive-vue'

Usage ​

vue
<script setup lang="ts">
import { useBalance } from '@growae/reactive-vue'

const { data, isLoading, error } = useBalance({
  address: 'ak_2dATGVvfU1oBShDDsaqfh1sF4bCkx2FKbiCaL2t4zZpMMpMfgE',
})
</script>

<template>
  <div v-if="isLoading">Loading...</div>
  <div v-else-if="error">Error: {{ error.shortMessage }}</div>
  <div v-else>{{ data.ae }} AE</div>
</template>

Return Type ​

See TanStack Vue Query docs for full return type. All values are Vue Refs.

data ​

See getBalance Return Type.

Parameters ​

address ​

  • Type: string | Ref<string>
  • Required

The account address. Accepts reactive refs.

query ​

See TanStack Vue Query docs for query options.

Action ​