• Preparing search index...
  • The search index is not available
@squonk/data-manager-client
  • @squonk/data-manager-client
  • job/job
  • useGetJob

Function useGetJob

  • useGetJob<TData = JobGetResponse, TError = ErrorType<void | DmError>>(
        jobId: number,
        params: undefined | GetJobParams,
        options: {
            query: Partial<UseQueryOptions<JobGetResponse, TError, TData>> & Pick<
                DefinedInitialDataOptions<JobGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = JobGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • jobId: number
    • params: undefined | GetJobParams
    • options: {
          query: Partial<UseQueryOptions<JobGetResponse, TError, TData>> & Pick<
              DefinedInitialDataOptions<JobGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/job/job.ts:385
  • useGetJob<TData = JobGetResponse, TError = ErrorType<void | DmError>>(
        jobId: number,
        params?: GetJobParams,
        options?: {
            query?: Partial<UseQueryOptions<JobGetResponse, TError, TData>> & Pick<
                UndefinedInitialDataOptions<JobGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = JobGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • jobId: number
    • Optionalparams: GetJobParams
    • Optionaloptions: {
          query?: Partial<UseQueryOptions<JobGetResponse, TError, TData>> & Pick<
              UndefinedInitialDataOptions<JobGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/job/job.ts:396
  • useGetJob<TData = JobGetResponse, TError = ErrorType<void | DmError>>(
        jobId: number,
        params?: GetJobParams,
        options?: {
            query?: Partial<UseQueryOptions<JobGetResponse, TError, TData>>;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = JobGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • jobId: number
    • Optionalparams: GetJobParams
    • Optionaloptions: {
          query?: Partial<UseQueryOptions<JobGetResponse, TError, TData>>;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/job/job.ts:407

Settings

Member Visibility
@squonk/data-manager-client
  • Loading...

Generated using TypeDoc