Skip to content

API reference / @backpack/rest-client / RestClientOptions

Interface: RestClientOptions

Options for configuring the REST client.

Properties

apiManagementSubscriptionKey?

ts
optional apiManagementSubscriptionKey: string;

Sets the Ocp-Apim-Subscription-Key header for every request.


baseUrl?

ts
optional baseUrl: string;

Sets the base URL to use for every request, additional URLs will be appended to it.


timeoutMilliseconds?

ts
optional timeoutMilliseconds: number;

Aborts every request after a fixed time.


userAgent?

ts
optional userAgent: string;

Sets the User-Agent header for every request.