Class RequestEngine

Index

Constructors

Methods

buildUrl getJson request

Constructors

constructor

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

Methods

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path and optional query parameters.
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in src/client/engine.ts:96

getJson

getJson<T>(path: string, query?: QueryParams): Promise<T>
GET a path with query params and parse the JSON reply into T.
Type Parameters
- T
Parameters
- path: string
- Optionalquery: QueryParams
Returns Promise<T>
- Defined in src/client/engine.ts:146

request

request(
    path: string,
    query?: QueryParams,
    accept?: string,
): Promise<RawResponse>
Perform a GET with Accept negotiation and transient-error retries. Redirects are NOT followed — the canonical host answers directly, so a 3xx (e.g. a bad base URL bouncing to a portal page) surfaces as an error.
Parameters
- path: string
- Optionalquery: QueryParams
- accept: string = "application/json"
Returns Promise<RawResponse>
- Defined in src/client/engine.ts:107