Class ApiFetchClient

apiClientOptions

extractQueryParams

• extractQueryParams<T extends { [key: string]: any }>(
      data: T,
      names: (keyof T)[],
  ): { [p in string | number | symbol]: string }

  Returns a map containing the query parameters based on the provided data and names.

  Type Parameters

  • T extends { [key: string]: any }

  Parameters

  • data: T

    The data object from which to extract query parameters.

  • names: (keyof T)[]

    An array of keys (property names) to extract from the data object.

  Returns { [p in string | number | symbol]: string }

  A map containing the extracted query parameters.

prepareOptions

• prepareOptions(
      url: string,
      method: string,
      queryParams: { [key: string]: string },
      headers: { [key: string]: string },
      body?: RequestBody,
      path?: string,
  ): Promise<RequestOptions>

  Asynchronously prepares options for an HTTP request.

  Parameters

  • url: string

    The URL for the HTTP request.

  • method: string

    The HTTP method for the request (e.g., 'GET', 'POST').

  • queryParams: { [key: string]: string }

    An object representing query parameters.

  • headers: { [key: string]: string }

    An object representing headers.

  • Optionalbody: RequestBody

    The request body, if applicable.

  • Optionalpath: string

    An optional path for the request.

  Returns Promise<RequestOptions>

  A promise that resolves to the prepared options for the HTTP request.

prepareUrl

• prepareUrl(
      url: string,
      queryParameters?: { [key: string]: string },
      repeatParamArray?: boolean,
  ): string

  Prepares the url to be called by appending query parameters.

  Parameters

  • url: string

    The base url to be used.

  • OptionalqueryParameters: { [key: string]: string }

    Key-value pair with the parameters. If the value is undefined, the key is dropped.

  • OptionalrepeatParamArray: boolean

    create as many single parameters with each value of the array

  Returns string

  The prepared URL as a string.