HttpResponseType

Used with TwinfinityApiClient.get to convert responses to correct data. See TwinfinityApiClient.get for an example.

Index

Properties

• arrayBuffer
• blob
• empty
• json
• text
• default

Methods

• arrayBuffer
• blob
• json
• status
• text

Properties

publicreadonlyarrayBuffer

arrayBuffer: (r: Response) => TypedResponse<ArrayBuffer>

Converts an array buffer Response to

<ArrayBuffer>

.

---

Type declaration

• • (r: Response): TypedResponse<ArrayBuffer>

  • Parameters

    • r: Response

    Returns TypedResponse<ArrayBuffer>

publicreadonlyblob

blob: (r: Response) => TypedResponse<Blob>

Converts a blob Response to

<Blob>

.

---

Type declaration

• • (r: Response): TypedResponse<Blob>

  • Parameters

    • r: Response

    Returns TypedResponse<Blob>

publicreadonlyempty

empty: (r: Response) => TypedResponse<undefined>

Converts an empty Response to

<undefined>

.

---

Type declaration

• • (r: Response): TypedResponse<undefined>

  • Parameters

    • r: Response

    Returns TypedResponse<undefined>

publicreadonlyjson

json: <T>(r: Response) => TypedResponse<T>

Converts a JSON Response to TypedResponse.

---

Type declaration

• • <T>(r: Response): TypedResponse<T>

  • Type parameters

    • T

    Parameters

    • r: Response

    Returns TypedResponse<T>

publicreadonlytext

text: (r: Response) => TypedResponse<string>

Converts a text Response to

<string>

.

---

Type declaration

• • (r: Response): TypedResponse<string>

  • Parameters

    • r: Response

    Returns TypedResponse<string>

publicstaticreadonlydefault

default: HttpResponseType = ...

By default, TypedResponse.value conversion methods only assign TypedResponse.value when Response.status === 200

Methods

publicstaticarrayBuffer

• arrayBuffer(r: Response): TypedResponse<ArrayBuffer>

• Converts an array buffer Response to

  <ArrayBuffer>

  .

  ---

  Parameters

  • r: Response

  Returns TypedResponse<ArrayBuffer>

publicstaticblob

• blob(r: Response): TypedResponse<Blob>

• Converts a blob Response to

  <Blob>

  .

  ---

  Parameters

  • r: Response

  Returns TypedResponse<Blob>

publicstaticjson

• json<T>(r: Response): TypedResponse<T>

• Converts a JSON Response to TypedResponse.

  ---

  Type parameters

  • T

  Parameters

  • r: Response

  Returns TypedResponse<T>

publicstaticstatus

• status(statuses: number[]): HttpResponseType

• Default is that TypedResponse.value is only valid if Response.status === 200 for responses sent into arrayBuffer, json, text and blob. Call this method to create a custom HttpResponseType where TypedResponse.value can be assigned for other status values as well. Example: A conflict response may still contain data which should be assigned to TypedResponse.value.

  ---

  Parameters

  • statuses: number[]

  Returns HttpResponseType

publicstatictext

• text(r: Response): TypedResponse<string>

• Converts a text Response to

  <string>

  .

  ---

  Parameters

  • r: Response

  Returns TypedResponse<string>