Class ApiXRequest

make

• make(): Promise<ApiXResponse<ApiXResponseData>>

  Sends the request to an API-X API server.

  Returns Promise<ApiXResponse<ApiXResponseData>>

  The response of the request.

  Throws

  Instances of Error if the request fails and the API-X backend does not have a response object.

  Note: Sending the same request more than once will cause it to fail as API-X backends do not accept repeat requests. Additionally, if the request is 'too old', it may fail. The API-X server determines what 'too old' means. This is to deter keeping request objects for too long as they should be destroyed quickly for security reasons.

StaticmakeRequest

• makeRequest(request: ApiXRequest): Promise<ApiXResponse<ApiXResponseData>>

  Sends a request to an API-X API server.

  Parameters

  • request: ApiXRequest

    The request that is sent to the server.

  Returns Promise<ApiXResponse<ApiXResponseData>>

  The response of the request.

  Throws

  Instances of Error if the request fails and the API-X backend does not have a response object.

  Note: Sending the same request more than once will cause it to fail as API-X backends do not accept repeat requests. Additionally, if the request is 'too old', it may fail. The API-X server determines what 'too old' means. This is to deter keeping request objects for too long as they should be destroyed quickly for security reasons.

constructor

• new ApiXRequest(config: ApiXRequestConfig): ApiXRequest

  Creates a new request object to make an API-X-compatible request.

  Parameters

  • config: ApiXRequestConfig

    The configuration of the request.

  Returns ApiXRequest

Optional Readonlydata

ReadonlyhttpMethod

Readonlyurl

cookies

• get cookies(): Record<string, string>

  Gets the current cookies as a record.

  Returns Record<string, string>

  A record of cookie name-value pairs.

addCookie

• addCookie(name: string, value: string): void

  Adds a single cookie.

  Parameters

  • name: string

    The name of the cookie.
  • value: string

    The value of the cookie.

  Returns void

getCookie

• getCookie(name: string): undefined | string

  Gets the value of a cookie.

  Parameters

  • name: string

    The name of the cookie (case-sensitive).

  Returns undefined | string

  The value of the cookie or undefined.

removeCookie

• removeCookie(name: string): void

  Removes a cookie by name.

  Parameters

  • name: string

    The name of the cookie to remove.

  Returns void

setCookies

• setCookies(cookies: Record<string, string>): void

  Sets multiple cookies at once. This method will overwrite cookies if needed, but it will keep existing ones that don't conflict with newly set ones.

  Parameters

  • cookies: Record<string, string>

    A record of cookie name-value pairs to set.

  Returns void

headers

• get headers(): Record<string, string>

  The HTTP headers in the request, excluding read-protected headers.

  These will not include any headers that contain sensitive information such as request signature.

  Returns Record<string, string>

header

• header(name: string): undefined | string

  Returns the value of any unprotected or write-protected header in the request.

  This will not get the Cookie unless it's set with setHeader. To get a cookie, use getCookie or cookies.

  Parameters

  • name: string

    The case-insensitive name of the header.

  Returns undefined | string

  The value of the header or undefined.

  Throws

  Error error if attempting to access a protected header.

setHeader

• setHeader(name: string, value: string): void

  Sets a header in the request. This will override any non-protected header in the request.

  Parameters

  • name: string

    The header name (e.g.: X-Custom-Header). The header will be set lowercased.
  • value: string

    The value in the header.

  Returns void

unsetHeader

• unsetHeader(name: string): void

  Unsets a header in the request. This will override any non-protected header in the request.

  Parameters

  • name: string

    The header name (e.g.: X-Custom-Header). Case-insensitive.

  Returns void