Skip to content

Function: useHttpElements()

ts
function useHttpElements(
  url: () => string,
  method: () => ResourcefulHttpMethod,
  headers: () => ResourcefulHttpHeaders,
  data: () => any,
  timeout: () => number | false,
  ttl: () => number | null,
  onComplete: () => void,
  onProgress: (progress: ResourcefulHttpProgress) => void,
  plain: () => boolean,
): {
  abort: () => void;
  exec: <T>() => Promise<ResourcefulHttpResponse<T>>;
  loaded: ComputedRef<boolean>;
  loading: ComputedRef<boolean>;
  percent: ComputedRef<number>;
};

Parameters

ParameterType
url() => string
method() => ResourcefulHttpMethod
headers() => ResourcefulHttpHeaders
data() => any
timeout() => number | false
ttl() => number | null
onComplete() => void
onProgress(progress: ResourcefulHttpProgress) => void
plain() => boolean

Returns

ts
{
  abort: () => void;
  exec: <T>() => Promise<ResourcefulHttpResponse<T>>;
  loaded: ComputedRef<boolean>;
  loading: ComputedRef<boolean>;
  percent: ComputedRef<number>;
}
NameTypeDefault value
abort()() => void-
exec()<T>() => Promise<ResourcefulHttpResponse<T>>-
loadedComputedRef<boolean>isLoadedOnce
loadingComputedRef<boolean>isLoading
percentComputedRef<number>-