useBlockListener
Kaspa DAG に追加された新しいブロックをリアクティブに監視します。block-added サブスクリプションを包み、各イベントを BlockInfo 型に変換します。
インポート
ts
import { useBlockListener } from 'vue-kaspa'戻り値の型
ts
interface UseBlockListenerReturn {
blocks: Readonly<Ref<BlockInfo[]>>
isListening: ComputedRef<boolean>
subscribe(): Promise<void>
unsubscribe(): Promise<void>
clear(): void
}オプション
ts
interface BlockListenerOptions {
maxHistory?: number
autoSubscribe?: boolean
}基本的な使い方
ts
import { useBlockListener } from 'vue-kaspa'
const { blocks, isListening } = useBlockListener()autoSubscribe: true が既定値です。コンポーネントのマウント時に自動で購読し、アンマウント時に解除します。
手動制御
ts
const { blocks, isListening, subscribe, unsubscribe, clear } = useBlockListener({
autoSubscribe: false,
maxHistory: 50,
})注意
block-addedを内部で使います。- 確定済みのトランザクションが必要な場合は
useTransactionListener()を使ってください。 maxHistoryで保持件数を制限できます。
