Class FederationHttpClient

HTTP federation client. Wrapper around the Got library, with additional options set.

internal

Hierarchy

FederationHttpClient

Index

Constructors

constructor

Properties

httpClient

Methods

Constructors

constructor

new FederationHttpClient(host: string, username?: string): FederationHttpClient

- Defined in packages/backend-federation-client/src/http-client.ts:37
Parameters
- host: string
  
  Host of the server to send requests.
- Optional username: string
  
  Username of the user for which requests are being sent on behalf of.
Returns FederationHttpClient

Properties

Readonly httpClient

httpClient: Got

Methods

delete

delete<T>(endpoints: Endpoints, options?: OptionsOfJSONResponseBody): Promise<T>

- Defined in packages/backend-federation-client/src/http-client.ts:121
DELETE wrapper around FederationHttpClient.request.

Type parameters
- T
Parameters
- endpoints: Endpoints
- Optional options: OptionsOfJSONResponseBody
Returns Promise<T>

get

get<T>(endpoints: Endpoints, options?: OptionsOfJSONResponseBody): Promise<T>

- Defined in packages/backend-federation-client/src/http-client.ts:100
GET wrapper around FederationHttpClient.request.

Type parameters
- T
Parameters
- endpoints: Endpoints
- Optional options: OptionsOfJSONResponseBody
Returns Promise<T>

Private joinEndpoints

joinEndpoints(endpoints: Endpoints): string

- Defined in packages/backend-federation-client/src/http-client.ts:60
Joins an array of endpoints into a string.

Parameters
- endpoints: Endpoints
  
  The endpoints to join.
Returns string

post

post<T>(endpoints: Endpoints, options?: OptionsOfJSONResponseBody): Promise<T>

- Defined in packages/backend-federation-client/src/http-client.ts:107
POST wrapper around FederationHttpClient.request.

Type parameters
- T
Parameters
- endpoints: Endpoints
- Optional options: OptionsOfJSONResponseBody
Returns Promise<T>

put

put<T>(endpoints: Endpoints, options?: OptionsOfJSONResponseBody): Promise<T>

- Defined in packages/backend-federation-client/src/http-client.ts:114
PUT wrapper around FederationHttpClient.request.

Type parameters
- T
Parameters
- endpoints: Endpoints
- Optional options: OptionsOfJSONResponseBody
Returns Promise<T>

request

request<T>(endpoints: Endpoints, method: HTTPAlias, options?: OptionsOfJSONResponseBody): Promise<T>

- Defined in packages/backend-federation-client/src/http-client.ts:83
Makes a request using the Got library, setting some default options required for federation

Type parameters
- T
Parameters
- endpoints: Endpoints
  
  The endpoints to join.
- method: HTTPAlias
  
  The HTTP method to use.
- Optional options: OptionsOfJSONResponseBody
  
  Optional options to use in the request.
Returns Promise<T>

Generated using TypeDoc