Http

Utility class for making HTTP requests. If requests are made to the Twinfinity backend then correct headers are automatically set.

Index

Constructors

• constructor

Methods

• delete
• fetch
• get
• patch
• post
• put
• setAuthorizationHeaderProvider

Constructors

constructor

• new Http(): Http

• Returns Http

Methods

publicstaticdelete

• delete<R>(absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a DELETE HTTP request

  ---

  Type parameters

  • R

  Parameters

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticfetch

• fetch<R>(method: HttpMethod, absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a HTTP request

  ---

  Type parameters

  • R

  Parameters

  • method: HttpMethod

    Method of http request.

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticget

• get<R>(absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a GET HTTP request

  ---

  Type parameters

  • R

  Parameters

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticpatch

• patch<R>(absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a PATCH HTTP request

  ---

  Type parameters

  • R

  Parameters

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticpost

• post<R>(absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a POST HTTP request

  ---

  Type parameters

  • R

  Parameters

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticput

• put<R>(absoluteUrl: string | URL, responseconverter: (r: Response) => TypedResponse<R>, init?: HttpRequestInit): Promise<TypedResponse<R>>

• Issues a PUT HTTP request

  ---

  Type parameters

  • R

  Parameters

  • absoluteUrl: string | URL

    Absolute url

  • responseconverter: (r: Response) => TypedResponse<R>

    How response should be converted. Use functions on HttpResponseType

  • optionalinit: HttpRequestInit

    Optional HttpRequestInit values.

  Returns Promise<TypedResponse<R>>

publicstaticsetAuthorizationHeaderProvider

• setAuthorizationHeaderProvider(authorizationHeaderProvider: AuthorizationHeaderProvider): void

• Parameters

  • authorizationHeaderProvider: AuthorizationHeaderProvider

  Returns void