Interface FlarumRequestOptions<ResponseType>

Type Parameters

ResponseType

Hierarchy

Omit<Mithril.RequestOptions<ResponseType>, "extract">
- FlarumRequestOptions

Index

Properties

errorHandler? extract? modifyText? url

Properties

`Optional` errorHandler

errorHandler?: ((error: RequestError<string>) => void)

Type declaration

- (error: RequestError<string>): void
- Parameters
  - error: RequestError<string>
  Returns void

`Optional` extract

extract?: ((responseText: string) => string)

Type declaration

- (responseText: string): string
- 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)

Type declaration

- (responseText: string): string
- Manipulate the response text before it is parsed into JSON.
  
  This overrides any extract method provided.
  Parameters
  - responseText: string
  Returns string

url

url: string

Generated using TypeDoc v0.23.24