Skip to content

Interface: Client ​

Defined in: src/core/interfaces/client.ts:3

Properties ​

host? ​

ts
readonly optional host?: string;

Defined in: src/core/interfaces/client.ts:13

The site this client sends to, as configured.

Absent under Cloud OAuth 2.0 (3LO), where the base URL is derived per request from the accessible resources, and absent on a client written by hand. A caller that needs to name the site — getTenantContext does — must treat it as optional.

Methods ​

sendRequest() ​

ts
sendRequest<T>(options): Promise<T>;

Defined in: src/core/interfaces/client.ts:4

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
optionsSendRequestOptions<T>

Returns ​

Promise<T>