From 1aa5d0ce814c293677c93c4fe07d7c0afe63977a Mon Sep 17 00:00:00 2001
From: Fanis Tharropoulos <ftharropoulos@gmail.com>
Date: Fri, 10 Jan 2025 17:48:56 +0200
Subject: [PATCH] docs: mention github issue and edge use-case for changing the
 adapter

---
 src/Typesense/Configuration.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/Typesense/Configuration.ts b/src/Typesense/Configuration.ts
index f79a2fe..60d7497 100644
--- a/src/Typesense/Configuration.ts
+++ b/src/Typesense/Configuration.ts
@@ -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"];