RequestEffect

---

import { RequestEffect } from "@hyper-fetch/core"

Description

Defined in effect/request.effect.ts:6

Parameters

Name	Details
config Required	RequestEffectOptionsType<T>

Properties

config

Description

Defined in effect/request.effect.ts:7

Type

RequestEffectOptionsType<T>

---

Methods

getEffectKey()

Preview

getEffectKey()

Description

Defined in effect/request.effect.ts:9

Return

string

---

onError()

Preview

onError(response, request)

Description

Defined in effect/request.effect.ts:22

Parameters

Name	Details
response Required	ResponseReturnErrorType<ExtractErrorType<T>, ExtractAdapterType<T>>
request Required	T

Return

void

---

onFinished()

Preview

onFinished(response, request)

Description

Defined in effect/request.effect.ts:25

Parameters

Name	Details
response Required	ResponseReturnType<ExtractResponseType<T>, ExtractErrorType<T>, ExtractAdapterType<T>>
request Required	T

Return

void

---

onStart()

Preview

onStart(request)

Description

Defined in effect/request.effect.ts:16

Parameters

Name	Details
request Required	T

Return

void

---

onSuccess()

Preview

onSuccess(response, request)

Description

Defined in effect/request.effect.ts:19

Parameters

Name	Details
response Required	ResponseReturnSuccessType<ExtractResponseType<T>, ExtractAdapterType<T>>
request Required	T

Return

void

---

onTrigger()

Preview

onTrigger(request)

Description

Defined in effect/request.effect.ts:13

Parameters

Name	Details
request Required	T

Return

void

---