Function useDownloadFile

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

  • Type Parameters

    Parameters

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

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

  • useDownloadFile<TData = void, TError = ErrorType<void | DmError>>(
        fileId: string,
        options?: {
            query?: Partial<UseQueryOptions<void, TError, TData>> & Pick<
                UndefinedInitialDataOptions<void, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }

  • Type Parameters

    Parameters

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

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

  • useDownloadFile<TData = void, TError = ErrorType<void | DmError>>(
        fileId: string,
        options?: {
            query?: Partial<UseQueryOptions<void, TError, TData>>;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }

  • Type Parameters

    Parameters

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

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

Settings

Member Visibility