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:130

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:143

getJson

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

request

request(
    path: string,
    query?: QueryParams,
    options?: RequestOptions,
): Promise<RawResponse>
Perform a GET with Accept/Accept-Language negotiation and transient-error retries. Redirects are NOT followed — a 3xx surfaces as an error.
Parameters
- path: string
- Optionalquery: QueryParams
- options: RequestOptions = {}
Returns Promise<RawResponse>
- Defined in src/client/engine.ts:153