Skip to main content
Version: 2.x.x

FetchEffect


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

Description

Defined in effect/fetch.effect.ts:6

Parameters

NameDetails

config

Required

FetchEffectConfig<T>

Properties

config

Description

Defined in effect/fetch.effect.ts:7

Type

FetchEffectConfig<T>

Methods

getEffectKey()

Preview

getEffectKey()

Description

Defined in effect/fetch.effect.ts:9

Return

string

onError()

Preview

onError(response, command)

Description

Defined in effect/fetch.effect.ts:22

Parameters

NameDetails

response

Required

ClientResponseErrorType<ExtractError<T>>

command

Required

T

Return

void

onFinished()

Preview

onFinished(response, command)

Description

Defined in effect/fetch.effect.ts:25

Parameters

NameDetails

response

Required

ClientResponseType<ResponseType, ExtractError<T>>

command

Required

T

Return

void

onStart()

Preview

onStart(command)

Description

Defined in effect/fetch.effect.ts:16

Parameters

NameDetails

command

Required

T

Return

void

onSuccess()

Preview

onSuccess(response, command)

Description

Defined in effect/fetch.effect.ts:19

Parameters

NameDetails

response

Required

ClientResponseSuccessType<ResponseType>

command

Required

T

Return

void

onTrigger()

Preview

onTrigger(command)

Description

Defined in effect/fetch.effect.ts:13

Parameters

NameDetails

command

Required

T

Return

void