Class FoundationHttpClient`Abstract`

Shared plumbing every OpenCDE REST client needs: Bearer token injection, JSON body encoding, and error mapping via fetchAndValidate. BcfApiClient and DocumentsApiClient both build on this rather than reimplementing it.

Hierarchy (View Summary)

FoundationHttpClient
- DocumentsApiClient
- FoundationApiClient

Index

Constructors

constructor

new FoundationHttpClient(
options?: FoundationHttpClientOptions,
): FoundationHttpClient
Parameters
- Optionaloptions: FoundationHttpClientOptions
Returns FoundationHttpClient

Properties

`Protected` `Readonly`errorLabel

errorLabel: string

`Protected` `Readonly`errorNamespace

errorNamespace: string | undefined

`Protected` `Readonly`fetchFn

fetchFn: FetchLike

`Protected` `Optional` `Readonly`getAccessToken

getAccessToken?: BcfTokenProvider

Methods

`Protected`requestJson

requestJson<T>(url: string, options?: HttpRequestOptions): Promise<T>
Type Parameters
- T
Parameters
- url: string
- Optionaloptions: HttpRequestOptions
Returns Promise<T>

`Protected`sendRequest

sendRequest(url: string, options?: HttpRequestOptions): Promise<Response>
Send a request to an already-fully-qualified URL and validate the response.
Parameters
- url: string
- Optionaloptions: HttpRequestOptions
Returns Promise<Response>

Class FoundationHttpClient`Abstract`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FoundationHttpClient

Properties

`Protected` `Readonly`errorLabel

`Protected` `Readonly`errorNamespace

`Protected` `Readonly`fetchFn

`Protected` `Optional` `Readonly`getAccessToken

Methods

`Protected`requestJson

Type Parameters

Parameters

Returns Promise<T>

`Protected`sendRequest

Parameters

Returns Promise<Response>

Settings

On This Page

Class FoundationHttpClientAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FoundationHttpClient

Properties

Protected ReadonlyerrorLabel

Protected ReadonlyerrorNamespace

Protected ReadonlyfetchFn

Protected Optional ReadonlygetAccessToken

Methods

ProtectedrequestJson

Type Parameters

Parameters

Returns Promise<T>

ProtectedsendRequest

Parameters

Returns Promise<Response>

Settings

On This Page

Class FoundationHttpClient`Abstract`

`Protected` `Readonly`errorLabel

`Protected` `Readonly`errorNamespace

`Protected` `Readonly`fetchFn

`Protected` `Optional` `Readonly`getAccessToken

`Protected`requestJson

`Protected`sendRequest