@azuro-org/sdk
Version:
One-stop solution for building betting dApps on the Azuro Protocol.
38 lines (37 loc) • 1.96 kB
TypeScript
import { type ChainId, type GetNavigationResult } from '@azuro-org/toolkit';
import { type UseQueryResult } from '@tanstack/react-query';
import { type SportHub, type QueryParameterWithSelect } from '../../global';
export type UseSportsNavigationQueryFnData = GetNavigationResult;
export type UseSportsNavigationProps<TData = UseSportsNavigationQueryFnData> = {
chainId?: ChainId;
filter?: {
sportHub?: SportHub;
sportIds?: Array<string | number>;
};
isLive?: boolean;
query?: QueryParameterWithSelect<UseSportsNavigationQueryFnData, TData>;
};
export type GetUseSportsNavigationQueryOptionsProps<TData = UseSportsNavigationQueryFnData> = UseSportsNavigationProps<TData> & {
chainId: ChainId;
};
export type UseSportsNavigation = <TData = UseSportsNavigationQueryFnData>(props?: UseSportsNavigationProps<TData>) => UseQueryResult<TData>;
export declare const getUseSportsNavigationQueryOptions: <TData = UseSportsNavigationQueryFnData>(params: GetUseSportsNavigationQueryOptionsProps<TData>) => import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<GetNavigationResult, Error, TData, readonly unknown[]>, "queryFn"> & {
queryFn?: import("@tanstack/query-core").QueryFunction<GetNavigationResult, readonly unknown[], never> | undefined;
} & {
queryKey: readonly unknown[] & {
[dataTagSymbol]: GetNavigationResult;
[dataTagErrorSymbol]: Error;
};
};
/**
* Get sports navigation data with countries and leagues hierarchy.
* Returns a flat list of sports with nested countries and leagues.
*
* - Docs: https://gem.azuro.org/hub/apps/sdk/data-hooks/useSportsNavigation
*
* @example
* import { useSportsNavigation } from '@azuro-org/sdk'
*
* const { data: sports, isFetching } = useSportsNavigation({ isLive: false })
* */
export declare const useSportsNavigation: <TData>(props?: UseSportsNavigationProps<TData>) => UseQueryResult<NoInfer<TData>, Error>;