/* eslint-disable @typescript-eslint/no-explicit-any */ /** * Generated by orval 🍺 * Do not edit manually. * API * API documentation for the starter-kit project in NestJS by BinarApps. The API allows management of users, sessions and offers various functions for logged in users. Contains examples of authentication, authorization, and CRUD for selected resources. * OpenAPI spec version: 1.0 */ import { useQuery } from '@tanstack/react-query' import type { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, QueryFunction, QueryKey, UndefinedInitialDataOptions, UseQueryOptions, UseQueryResult, } from '@tanstack/react-query' import { customInstance } from '../../axios/custom-instance' import type { ErrorType } from '../../axios/custom-instance' import type { ErrorEntity, HealthEntity } from '../../types' type SecondParameter any> = Parameters[1] /** * Performs a health check, verifying the database, frontend domain, and cache connectivity. * @summary Check Health */ export const healthControllerCheck = ( options?: SecondParameter, signal?: AbortSignal ) => { return customInstance({ url: `/api/v1/health`, method: 'GET', signal }, options) } export const getHealthControllerCheckQueryKey = () => { return [`/api/v1/health`] as const } export const getHealthControllerCheckQueryOptions = < TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }) => { const { query: queryOptions, request: requestOptions } = options ?? {} const queryKey = queryOptions?.queryKey ?? getHealthControllerCheckQueryKey() const queryFn: QueryFunction>> = ({ signal }) => healthControllerCheck(requestOptions, signal) return { queryKey, queryFn, ...queryOptions } as UseQueryOptions< Awaited>, TError, TData > & { queryKey: DataTag } } export type HealthControllerCheckQueryResult = NonNullable< Awaited> > export type HealthControllerCheckQueryError = ErrorType export function useHealthControllerCheck< TData = Awaited>, TError = ErrorType, >(options: { query: Partial< UseQueryOptions>, TError, TData> > & Pick< DefinedInitialDataOptions>, TError, TData>, 'initialData' > request?: SecondParameter }): DefinedUseQueryResult & { queryKey: DataTag } export function useHealthControllerCheck< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial< UseQueryOptions>, TError, TData> > & Pick< UndefinedInitialDataOptions>, TError, TData>, 'initialData' > request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } export function useHealthControllerCheck< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } /** * @summary Check Health */ export function useHealthControllerCheck< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } { const queryOptions = getHealthControllerCheckQueryOptions(options) const query = useQuery(queryOptions) as UseQueryResult & { queryKey: DataTag } query.queryKey = queryOptions.queryKey return query }