Class RequestEngine

Index

Constructors

Methods

buildUrl getJson getRaw request

Constructors

constructor

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

Methods

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path and optional query parameters. The base URL was checked by the constructor (validateBaseUrl): an http(s) URL without a query or fragment, so the path is appended as text. Its scheme is enforced there, transport-independently, so a library user who injects a custom Transport still cannot reach a file:/ftp: driver.
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in packages/client/src/engine.ts:493

getJson

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

getRaw

getRaw(path: string, accept: string, query?: QueryParams): Promise<RawResponse>
Perform a GET returning the raw bytes (GeoJSON / RSS / image downloads).
Parameters
- path: string
- accept: string
- Optionalquery: QueryParams
Returns Promise<RawResponse>
- Defined in packages/client/src/engine.ts:594

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