Class RequestEngine

Index

Constructors

Methods

buildUrl getJson getRaw getText request

Constructors

constructor

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

Methods

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path and optional query parameters.

Throws a DdbError for a path with a "." or ".." segment. The client puts ids, collections and request handlers into the path with encodeURIComponent, which leaves those two unchanged, and URL parsing then resolves them: a collection of ".." with handler "version" would request /2/search/version. Neither can name a resource. (Percent-encoded forms such as "%2e%2e" are safe: encodeURIComponent turns their "%" into "%25".)
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in packages/client/src/engine.ts:566

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

getRaw

getRaw(
    path: string,
    accept: string,
    query?: QueryParams,
    followRedirect?: (target: URL) => boolean,
): Promise<RawResponse>
Perform a GET returning the raw bytes (binary downloads).
Parameters
- path: string
- accept: string
- Optionalquery: QueryParams
- OptionalfollowRedirect: (target: URL) => boolean
Returns Promise<RawResponse>
- Defined in packages/client/src/engine.ts:825

getText

getText(path: string, query?: QueryParams): Promise<string>
Perform a GET returning the decoded response body as text (e.g. /version).
Parameters
- path: string
- Optionalquery: QueryParams
Returns Promise<string>
- Defined in packages/client/src/engine.ts:819

request

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