HttpUtil | @rds/sdk

Utility to make strongly typed HTTP requests. Uses the Fetch API.

Hierarchy

HttpUtil

Index

Methods

Static get

get<T>(path: string, args?: RequestInit): Promise<HttpResponse<T>>

- Defined in src/utils/http.ts:48
Make a strongly typed http GET request.

example

const response = await HttpUtil.get<{ id: number }>( "https://jsonplaceholder.typicode.com/posts" );

Type parameters
- T
Parameters
- path: string
  
  url for the request
- Default value args: RequestInit = { method: 'get' }
  
  fetch API args, defaults to { method: 'get' }
Returns Promise<HttpResponse<T>>

a typed async http reponse

Static post

post<T>(path: string, body: any, args?: RequestInit): Promise<HttpResponse<T>>

- Defined in src/utils/http.ts:66
Make a strongly typed http POST request.

example

const response = await HttpUtil.post<{ id: number }>( "https://jsonplaceholder.typicode.com/posts", { title: "my post", body: "some content" } );

Type parameters
- T
Parameters
- path: string
  
  url for the request
- body: any
  
  request's body
- Default value args: RequestInit = { method: 'post', body: JSON.stringify(body) }
  
  fetch API args, defaults to { method: 'post', body: JSON.stringify(body) }
Returns Promise<HttpResponse<T>>

a typed async http reponse

Static put

put<T>(path: string, body: any, args?: RequestInit): Promise<HttpResponse<T>>

- Defined in src/utils/http.ts:88
Make a strongly typed http PUT request.

example

const response = await HttpUtil.put<{ id: number }>( "https://jsonplaceholder.typicode.com/posts", { title: "my post", body: "some content" } );

Type parameters
- T
Parameters
- path: string
  
  url for the request
- body: any
  
  request's body
- Default value args: RequestInit = { method: 'put', body: JSON.stringify(body) }
  
  fetch API args, defaults to { method: 'put', body: JSON.stringify(body) }
Returns Promise<HttpResponse<T>>

a typed async http reponse

Static request

request<T>(req: RequestInfo): Promise<HttpResponse<T>>

- Defined in src/utils/http.ts:20
Utility function to make a fully typed http request with the fetch API.

example

const response = await HttpUtil.request<Todo[]>( "https://jsonplaceholder.typicode.com/todos" );

Type parameters
- T
Parameters
- req: RequestInfo
  
  This Fetch API interface represents a resource request.
Returns Promise<HttpResponse<T>>

a typed async http reponse

Generated using TypeDoc

Hierarchy

Index

Methods

Methods

Static get

Type parameters

T

Parameters

path: string

Default value args: RequestInit = { method: 'get' }

Returns Promise<HttpResponse<T>>

Static post

Type parameters

T

Parameters

path: string

body: any

Default value args: RequestInit = { method: 'post', body: JSON.stringify(body) }

Returns Promise<HttpResponse<T>>

Static put

Type parameters

T

Parameters

path: string

body: any

Default value args: RequestInit = { method: 'put', body: JSON.stringify(body) }

Returns Promise<HttpResponse<T>>

Static request

Type parameters

T

Parameters

req: RequestInfo

Returns Promise<HttpResponse<T>>