Class RequestEngine

Index

Constructors

Methods

buildUrl getJson request scrub

Constructors

constructor

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

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 packages/client/src/engine.ts:596

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 packages/client/src/engine.ts:679

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 packages/client/src/engine.ts:606

scrub

scrub(text: string): string
text without the base URL's credentials: server text (an error body that echoes the request URL) and transport text (fetch's "Failed to fetch ") can carry them. Public so the client can scrub the envelope text it turns into errors.
Parameters
- text: string
Returns string
- Defined in packages/client/src/engine.ts:528