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

Function useGetDatasetDigest

  • useGetDatasetDigest<
        TData = DatasetDigestGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        datasetDigest: string,
        options: {
            query: Partial<
                UseQueryOptions<DatasetDigestGetResponse, TError, TData>,
            > & Pick<
                DefinedInitialDataOptions<DatasetDigestGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • datasetDigest: string
    • options: {
          query: Partial<UseQueryOptions<DatasetDigestGetResponse, TError, TData>> & Pick<
              DefinedInitialDataOptions<DatasetDigestGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/digest/digest.ts:83
  • useGetDatasetDigest<
        TData = DatasetDigestGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        datasetDigest: string,
        options?: {
            query?: Partial<
                UseQueryOptions<DatasetDigestGetResponse, TError, TData>,
            > & Pick<
                UndefinedInitialDataOptions<DatasetDigestGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • datasetDigest: string
    • Optionaloptions: {
          query?: Partial<
              UseQueryOptions<DatasetDigestGetResponse, TError, TData>,
          > & Pick<
              UndefinedInitialDataOptions<DatasetDigestGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/digest/digest.ts:93
  • useGetDatasetDigest<
        TData = DatasetDigestGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        datasetDigest: string,
        options?: {
            query?: Partial<
                UseQueryOptions<DatasetDigestGetResponse, TError, TData>,
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

    • datasetDigest: string
    • Optionaloptions: {
          query?: Partial<
              UseQueryOptions<DatasetDigestGetResponse, TError, TData>,
          >;
          request?: AxiosRequestConfig;
      }

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

    • Defined in src/digest/digest.ts:103

Settings

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

Generated using TypeDoc