ApiRequestOptions interface

The API request options.

Signature:

export interface ApiRequestOptions 

Properties

api

The API that is going to be requested (excluding the version, shieldbow only uses the latest versions).

Type: keyof MethodRateLimitConfig

method

The method that is being used, used for rate limiting.

Type: String

params

A string containing parameters to be used for error messages.

Type: String

region

The region to make the request to.

Type: Region

regional

Whether to use regional routing values (euw, na) or region API bases (americas, europe).

Type: Boolean