UNPKG

wagmi

Version:

React Hooks for Ethereum

14 lines 2.25 kB
import type { Config, GetBlockErrorType, ResolvedRegister } from '@wagmi/core'; import type { Compute, UnionCompute, UnionStrictOmit } from '@wagmi/core/internal'; import { type GetBlockData, type GetBlockOptions, type GetBlockQueryFnData, type GetBlockQueryKey } from '@wagmi/core/query'; import type { BlockTag } from 'viem'; import type { ConfigParameter, QueryParameter } from '../types/properties.js'; import { type UseQueryReturnType } from '../utils/query.js'; import { type UseWatchBlocksParameters } from './useWatchBlocks.js'; export type UseBlockParameters<includeTransactions extends boolean = false, blockTag extends BlockTag = 'latest', config extends Config = Config, chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], selectData = GetBlockData<includeTransactions, blockTag, config, chainId>> = Compute<GetBlockOptions<includeTransactions, blockTag, config, chainId> & ConfigParameter<config> & QueryParameter<GetBlockQueryFnData<includeTransactions, blockTag, config, chainId>, GetBlockErrorType, selectData, GetBlockQueryKey<includeTransactions, blockTag, config, chainId>> & { watch?: boolean | UnionCompute<UnionStrictOmit<UseWatchBlocksParameters<includeTransactions, blockTag, config, chainId>, 'chainId' | 'config' | 'onBlock' | 'onError'>> | undefined; }>; export type UseBlockReturnType<includeTransactions extends boolean = false, blockTag extends BlockTag = 'latest', config extends Config = Config, chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], selectData = GetBlockData<includeTransactions, blockTag, config, chainId>> = UseQueryReturnType<selectData, GetBlockErrorType>; /** https://wagmi.sh/react/hooks/useBlock */ export declare function useBlock<includeTransactions extends boolean = false, blockTag extends BlockTag = 'latest', config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], selectData = GetBlockData<includeTransactions, blockTag, config, chainId>>(parameters?: UseBlockParameters<includeTransactions, blockTag, config, chainId, selectData>): UseBlockReturnType<includeTransactions, blockTag, config, chainId, selectData>; //# sourceMappingURL=useBlock.d.ts.map