synapse-react-client/dist/synapse-queries/user/useFavorites.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

import { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError';
import { EntityHeader, FavoriteSortBy, FavoriteSortDirection, PaginatedResults } from '@sage-bionetworks/synapse-types';
import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
export declare function useIsFavorite(entityId: string): {
    isFavorite: boolean | undefined;
    isLoading: boolean;
};
export declare function useAddFavorite(options?: Partial<UseMutationOptions<EntityHeader, SynapseClientError, string>>): import("@tanstack/react-query").UseMutationResult<EntityHeader, SynapseClientError, string, unknown>;
export declare function useRemoveFavorite(options?: Partial<UseMutationOptions<void, SynapseClientError, string>>): import("@tanstack/react-query").UseMutationResult<void, SynapseClientError, string, unknown>;
export declare function useGetFavorites(sort?: FavoriteSortBy, sortDirection?: FavoriteSortDirection, options?: Partial<UseQueryOptions<EntityHeader[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<EntityHeader[], SynapseClientError>;
export declare function useGetFavoritesInfinite<TData = InfiniteData<PaginatedResults<EntityHeader>>>(sort?: FavoriteSortBy, sortDirection?: FavoriteSortDirection, options?: Partial<UseInfiniteQueryOptions<PaginatedResults<EntityHeader>, SynapseClientError, TData, QueryKey, number | undefined>>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
//# sourceMappingURL=useFavorites.d.ts.map