Class RequestEngine

Index

Constructors

Methods

buildUrl getJson postJson postRaw

Constructors

constructor

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

Methods

buildUrl

buildUrl(path: string): string
Build a fully-qualified URL from a path (parameters travel in the body).
Parameters
- path: string
Returns string
- Defined in src/client/engine.ts:141

getJson

getJson<T>(path: string): Promise<T>
GET a JSON body without credentials (helloworld/whoami).
Type Parameters
- T
Parameters
- path: string
Returns Promise<T>
- Defined in src/client/engine.ts:209

postJson

postJson<T>(
    path: string,
    params: QueryParams,
    authHeaders: Record<string, string>,
): Promise<T>
POST form-encoded params (with credential headers) and parse the JSON reply.
Type Parameters
- T
Parameters
- path: string
- params: QueryParams
- authHeaders: Record<string, string>
Returns Promise<T>
- Defined in src/client/engine.ts:215

postRaw

postRaw(
    path: string,
    accept: string,
    params: QueryParams,
    authHeaders: Record<string, string>,
): Promise<RawResponse>
POST form-encoded params and return the raw bytes (file / binary downloads). If the server answered with JSON instead of the expected binary (e.g. a credential or "too large" error on a data/*file endpoint), the logical Status is checked so the failure surfaces cleanly.
Parameters
- path: string
- accept: string
- params: QueryParams
- authHeaders: Record<string, string>
Returns Promise<RawResponse>
- Defined in src/client/engine.ts:230