Class RequestEngine

Index

Constructors

Methods

buildAbsoluteUrl buildUrl getJson getJsonAbsolute request

Constructors

constructor

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

Methods

buildAbsoluteUrl

buildAbsoluteUrl(absoluteUrl: string, query?: QueryParams): string
Build a fully-qualified URL from an absolute base URL and optional query.
Parameters
- absoluteUrl: string
- Optionalquery: QueryParams
Returns string
- Defined in src/client/engine.ts:166

buildUrl

buildUrl(path: string, query?: QueryParams): string
Build a fully-qualified URL from a path (on the data host) and optional query.
Parameters
- path: string
- Optionalquery: QueryParams
Returns string
- Defined in src/client/engine.ts:159

getJson

getJson<T>(path: string, query?: QueryParams): Promise<T>
GET a path on the data host and parse the JSON reply into T.
Type Parameters
- T
Parameters
- path: string
- Optionalquery: QueryParams
Returns Promise<T>
- Defined in src/client/engine.ts:229

getJsonAbsolute

getJsonAbsolute<T>(absoluteUrl: string, query?: QueryParams): Promise<T>
GET a fully-qualified absolute URL (e.g. the catalogue host) and parse JSON into T.
Type Parameters
- T
Parameters
- absoluteUrl: string
- Optionalquery: QueryParams
Returns Promise<T>
- Defined in src/client/engine.ts:234

request

request(
    path: string,
    query?: QueryParams,
    accept?: string,
): Promise<RawResponse>
GET a path on the data host with query params.
Parameters
- path: string
- Optionalquery: QueryParams
- accept: string = "application/json"
Returns Promise<RawResponse>
- Defined in src/client/engine.ts:224