Files
supabase/apps/studio/data/projects/project-pause-status-query.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

40 lines
1.2 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { get, handleError } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { projectKeys } from './keys'
export type ProjectPauseStatusVariables = { ref?: string }
export async function getProjectPausedStatus(
{ ref }: ProjectPauseStatusVariables,
signal?: AbortSignal
) {
if (!ref) throw new Error('Project ref is required')
const { data, error } = await get('/platform/projects/{ref}/pause/status', {
params: { path: { ref } },
signal,
})
if (error) handleError(error)
return data
}
export type ProjectPauseStatusData = Awaited<ReturnType<typeof getProjectPausedStatus>>
export type ProjectPauseStatusError = ResponseError
export const useProjectPauseStatusQuery = <TData = ProjectPauseStatusData>(
{ ref }: ProjectPauseStatusVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<ProjectPauseStatusData, ProjectPauseStatusError, TData> = {}
) =>
useQuery<ProjectPauseStatusData, ProjectPauseStatusError, TData>({
queryKey: projectKeys.pauseStatus(ref),
queryFn: ({ signal }) => getProjectPausedStatus({ ref }, signal),
enabled: enabled && typeof ref !== 'undefined',
...options,
})