Skip to content

Commit

Permalink
docs: mention github issue and edge use-case for changing the adapter
Browse files Browse the repository at this point in the history
  • Loading branch information
tharropoulos committed Jan 10, 2025
1 parent 0222ffb commit 1aa5d0c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/Typesense/Configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ export interface ConfigurationOptions {
/**
* Set a custom axios adapter
*
* Useful for customizing the underlying HTTP client library used by Typesense.
*
* For example, you can use this to use a custom HTTP client library like `fetch`, in order for the library to work on the edge.
* Related GiHub issue: https://github.com/typesense/typesense-js/issues/161
*
* See axios documentation for more information on how to use this parameter: https://axios-http.com/docs/req_config
*/
axiosAdapter?: AxiosRequestConfig["adapter"];
Expand Down

0 comments on commit 1aa5d0c

Please sign in to comment.