Class RequestEngine

Index

Constructors

Methods

buildUrl getJson request

Constructors

constructor

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

Methods

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path and optional query parameters. It keeps the base URL's userinfo; request() sends it as an Authorization header instead.
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in packages/client/src/engine.ts:449

getJson

getJson<T>(
    path: string,
    query?: QueryParams,
    shape?: (value: unknown) => string | undefined,
): Promise<T>
Perform a GET expecting JSON and parse it into T. With shape, the parsed body must pass it (see responseShapeProblem in client.ts): a 2xx body without the documented envelope (null, {}, an error object, a proxy's text) is a LuftParseError naming the path, never data.
Type Parameters
- T
Parameters
- path: string
- Optionalquery: QueryParams
- Optionalshape: (value: unknown) => string | undefined
Returns Promise<T>
- Defined in packages/client/src/engine.ts:664

request

request(
    method: string,
    path: string,
    options?: { accept: string; query?: QueryParams },
): Promise<RawResponse>
Perform a request with Accept negotiation and transient-error retries.
Parameters
- method: string
- path: string
- options: { accept: string; query?: QueryParams } = ...
Returns Promise<RawResponse>
- Defined in packages/client/src/engine.ts:487