@serenity-is/corelib / ServiceOptions

Interface: ServiceOptions<TResponse>

Type parameters

Name	Type
TResponse	extends ServiceResponse

Hierarchy

• RequestInit

  ↳ ServiceOptions

Table of contents

Properties

• allowRedirect
• async
• blockUI
• headers
• request
• service
• url

Methods

• onCleanup
• onError
• onSuccess

Properties

allowRedirect

• Optional allowRedirect: boolean

Defined in

src/base/servicetypes.ts:116

---

async

• Optional async: boolean

Defined in

src/base/servicetypes.ts:117

---

blockUI

• Optional blockUI: boolean

Defined in

src/base/servicetypes.ts:118

---

headers

• Optional headers: Record<string, string>

Overrides

RequestInit.headers

Defined in

src/base/servicetypes.ts:119

---

request

• Optional request: any

Defined in

src/base/servicetypes.ts:120

---

service

• Optional service: string

Defined in

src/base/servicetypes.ts:121

---

url

• Optional url: string

Defined in

src/base/servicetypes.ts:122

Methods

onCleanup

▸ onCleanup(): void

Returns

void

Defined in

src/base/servicetypes.ts:123

---

onError

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

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

Parameters

Name	Type
response	TResponse
info?	RequestErrorInfo

Returns

boolean | void

Defined in

src/base/servicetypes.ts:125

---

onSuccess

▸ onSuccess(response): void

Parameters

Name	Type
response	TResponse

Returns

void

Defined in

src/base/servicetypes.ts:126