ESPRMRequestConfig
Defined in: src/types/config.ts:36
Configuration for an API request made through ESPRMAPIManager.
Properties
Section titled “Properties”baseURL?
Section titled “baseURL?”
optionalbaseURL?:string
Defined in: src/types/config.ts:54
Override the base URL for this request.
Security note: when used with ESPRMAPIManager.authorizeRequest, the
user’s access token is sent to this host. Only point it at the trusted
ESP RainMaker deployment; never at a URL derived from untrusted input.
optionaldata?:object|Record<string,unknown>
Defined in: src/types/config.ts:42
Request body data (will be JSON-stringified).
headers?
Section titled “headers?”
optionalheaders?:Record<string,string>
Defined in: src/types/config.ts:46
Additional HTTP headers.
method
Section titled “method”method:
string
Defined in: src/types/config.ts:40
The HTTP method to use.
params?
Section titled “params?”
optionalparams?:object|Record<string,string>
Defined in: src/types/config.ts:44
URL query parameters.
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: src/types/config.ts:56
Per-request timeout in milliseconds; overrides the configured default.
url:
string
Defined in: src/types/config.ts:38
The API endpoint path (appended to the base URL).