Interface ApiQueryRequestOptions<ResponseType>

Type parameters

ResponseType

Hierarchy

Omit<FlarumRequestOptions<ResponseType>, "url">
- ApiQueryRequestOptions

Index

Methods

Methods

Optional errorHandler

errorHandler(error: RequestError<string>): void

Inherited from Omit.errorHandler
- Defined in src/common/Application.tsx:42
Parameters
- error: RequestError<string>
Returns void

Optional extract

extract(responseText: string): string

Inherited from Omit.extract
- Defined in src/common/Application.tsx:50
Manipulate the response text before it is parsed into JSON.

deprecated
Please use modifyText instead.

Parameters
- responseText: string
Returns string

Optional modifyText

modifyText(responseText: string): string

Inherited from Omit.modifyText
- Defined in src/common/Application.tsx:56
Manipulate the response text before it is parsed into JSON.

This overrides any extract method provided.

Parameters
- responseText: string
Returns string

Generated using TypeDoc version 0.22.10