Type Alias CommonServiceParams<ApiRequest, ApiResponse>

Type Declaration

• 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

  Keep only the latest search with createLatestRequest:

  const latestSearch = createLatestRequest();
  const search = await latestSearch.run((signal) => discoverPlaces({ query, signal }));
  if (search.current) showResults(search.value);
  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