Class RequestEngine

Index

Constructors

Methods

buildUrl getJson request

Constructors

constructor

new RequestEngine(options?: EngineOptions): RequestEngine
Parameters
- options: EngineOptions = {}
Returns RequestEngine
- Defined in packages/client/src/engine.ts:428

Methods

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path and optional query parameters.

The base URL (checked by the constructor, validateBaseUrl) is decomposed via the WHATWG URL parser rather than blindly concatenated, so its scheme, host and own path prefix are kept exactly.
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in packages/client/src/engine.ts:524

getJson

getJson<T>(path: string, query?: QueryParams): Promise<T>
Perform a GET expecting JSON and parse it into T.
Type Parameters
- T
Parameters
- path: string
- Optionalquery: QueryParams
Returns Promise<T>
- Defined in packages/client/src/engine.ts:754

request

request(
    method: string,
    path: string,
    options?: { accept: string; query?: QueryParams },
): Promise<RawResponse>
Perform a request with Accept negotiation and transient-error retries.
Parameters
- method: string
- path: string
- options: { accept: string; query?: QueryParams } = ...
Returns Promise<RawResponse>
- Defined in packages/client/src/engine.ts:572