@serenity-is/corelib / ServiceOptions

Interface: ServiceOptions<TResponse>

Defined in: src/base/servicetypes.ts:102

Extends

• RequestInit

Type Parameters

TResponse

TResponse extends ServiceResponse

Properties

allowRedirect?

optional allowRedirect: boolean

Defined in: src/base/servicetypes.ts:103

---

async?

optional async: boolean

Defined in: src/base/servicetypes.ts:104

---

blockUI?

optional blockUI: boolean

Defined in: src/base/servicetypes.ts:105

---

errorMode?

optional errorMode: "none" | "alert" | "notification"

Defined in: src/base/servicetypes.ts:110

---

headers?

optional headers: Record<string, string>

Defined in: src/base/servicetypes.ts:106

A Headers object, an object literal, or an array of two-item arrays to set request's headers.

Overrides

RequestInit.headers

---

request?

optional request: any

Defined in: src/base/servicetypes.ts:107

---

service?

optional service: string

Defined in: src/base/servicetypes.ts:108

---

url?

optional url: string

Defined in: src/base/servicetypes.ts:109

Methods

onCleanup()?

optional onCleanup(): void

Defined in: src/base/servicetypes.ts:111

Returns

void

---

onError()?

optional onError(response, info?): boolean | void

Defined in: src/base/servicetypes.ts:113

Should return true if the error is handled (e.g. notification shown). Otherwise the error may be shown twice.

Parameters

response

TResponse

info?

RequestErrorInfo

Returns

boolean | void

---

onSuccess()?

optional onSuccess(response): void

Defined in: src/base/servicetypes.ts:114

Parameters

response

TResponse

Returns

void