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

Function useGetInstancesSuspense

  • useGetInstancesSuspense<
        TData = InstancesGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params: undefined | GetInstancesParams,
        options: {
            query: Partial<
                UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
            >;
            request?: AxiosRequestConfig;
        },
    ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • params: undefined | GetInstancesParams
    • options: {
          query: Partial<
              UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/instance/instance.ts:248
  • useGetInstancesSuspense<
        TData = InstancesGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params?: GetInstancesParams,
        options?: {
            query?: Partial<
                UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
            >;
            request?: AxiosRequestConfig;
        },
    ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • Optionalparams: GetInstancesParams
    • Optionaloptions: {
          query?: Partial<
              UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/instance/instance.ts:252
  • useGetInstancesSuspense<
        TData = InstancesGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params?: GetInstancesParams,
        options?: {
            query?: Partial<
                UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
            >;
            request?: AxiosRequestConfig;
        },
    ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • Optionalparams: GetInstancesParams
    • Optionaloptions: {
          query?: Partial<
              UseSuspenseQueryOptions<InstancesGetResponse, TError, TData>,
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/instance/instance.ts:256

Settings

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

Generated using TypeDoc