Class RequestEngine

Index

Constructors

Methods

buildUrl postJson request

Constructors

constructor

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

Methods

buildUrl

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

postJson

postJson<T>(path: string, payload: unknown): Promise<T>
POST a JSON payload and parse the JSON reply into T.
Type Parameters
- T
Parameters
- path: string
- payload: unknown
Returns Promise<T>
- Defined in src/client/engine.ts:157

request

request(
    method: string,
    path: string,
    options?: { accept: string; body?: Buffer<ArrayBufferLike> },
): Promise<RawResponse>
Perform a request with Accept negotiation and transient-error retries.

Redirects are deliberately NOT followed: the canonical host answers directly, and following a cross-origin 3xx blindly is a footgun. A 3xx therefore surfaces as an error, with a hint to use the canonical base URL.
Parameters
- method: string
- path: string
- options: { accept: string; body?: Buffer<ArrayBufferLike> } = ...
Returns Promise<RawResponse>
- Defined in src/client/engine.ts:112