Class 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

`Static`delete

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>>

`Static`fetch

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>>

`Static`get

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>>

`Static`patch

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>>

`Static`post

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>>

`Static`put

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>>

`Static`setAuthorizationHeaderProvider

setAuthorizationHeaderProvider(
authorizationHeaderProvider: AuthorizationHeaderProvider,
): void
Parameters
- authorizationHeaderProvider: AuthorizationHeaderProvider
Returns void

Class Http

Index

Constructors

Methods

Constructors

constructor

Returns Http

Methods

`Static`delete

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`fetch

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`get

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`patch

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`post

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`put

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

`Static`setAuthorizationHeaderProvider

Parameters

Returns void

Settings

On This Page

Class Http

Index

Constructors

Methods

Constructors

constructor

Returns Http

Methods

Staticdelete

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

Staticfetch

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

Staticget

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

Staticpatch

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

Staticpost

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

Staticput

Type Parameters

Parameters

Returns Promise<TypedResponse<R>>

StaticsetAuthorizationHeaderProvider

Parameters

Returns void

Settings

On This Page

`Static`delete

`Static`fetch

`Static`get

`Static`patch

`Static`post

`Static`put

`Static`setAuthorizationHeaderProvider