Type Alias CommonServiceParams<ApiRequest, ApiResponse>

Type Declaration

• OptionalcustomServiceBaseURL?: string

  Custom base URL for the service endpoint.

  Remarks

  Should contain the URL up to the part that changes per service call.

  Example

  customServiceBaseURL: 'https://api.tomtom.com/search/10/reverseGeocode/'
  Copy

  Default Value

  undefined (uses default service URL)

• OptionalonAPIRequest?: (apiRequest: ApiRequest) => void

  Callback invoked immediately before sending the request to the API.

  Remarks

  Useful for tracking, logging, or debugging API requests before they are sent to the server.

• OptionalonAPIResponse?: (apiRequest: ApiRequest, apiResponse: ApiResponse) => void

  Callback invoked when the raw response is received from the API.

  Remarks

  Called as soon as the API response is received, before parsing. The request object is the same reference as provided to onAPIRequest. Useful for tracking, logging, or debugging successful API request-response pairs.

• Optionalsignal?: AbortSignal

  An AbortSignal used to cancel the request.

  Remarks

  Aborting rejects the call with an SDKAbortError (its name is 'AbortError') and cancels the underlying HTTP request, including while the SDK is waiting to retry a rate-limited (429) response. Aborting a call that already completed has no effect.

  Compose signals to add a deadline: AbortSignal.any([mine, AbortSignal.timeout(5000)]).

  Example

  Cancel the previous search whenever a new one starts:

  let controller: AbortController | undefined;
  
  const searchForQuery = async (query: string) => {
      controller?.abort();
      controller = new AbortController();
      try {
          return await search({ query, signal: controller.signal });
      } catch (error) {
          if (error instanceof SDKAbortError) return;
          throw error;
      }
  };
  Copy

  Default Value

  undefined (the request cannot be cancelled)

• OptionalvalidateRequest?: boolean

  Controls whether input request schema validation is performed.

  Remarks

  When enabled, the SDK validates request parameters against the expected schema before sending the request to the API. Set to false to skip validation.

  Default Value

  true