From d06f0da1d070d6395e7def851d025ce4cc894670 Mon Sep 17 00:00:00 2001
From: slvrtrn <hypnoash@gmail.com>
Date: Mon, 16 Dec 2024 19:26:36 +0100
Subject: [PATCH] Update the JSDoc

---
 packages/client-common/src/config.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/packages/client-common/src/config.ts b/packages/client-common/src/config.ts
index f108e98..b7a7179 100644
--- a/packages/client-common/src/config.ts
+++ b/packages/client-common/src/config.ts
@@ -39,13 +39,16 @@ export interface BaseClickHouseClientConfigOptions {
     request?: boolean
   }
   /** The name of the user on whose behalf requests are made.
+   *  Should not be set if {@link access_token} is provided.
    *  @default default */
   username?: string
   /** The user password.
+   *  Should not be set if {@link access_token} is provided.
    *  @default empty string */
   password?: string
   /** A JWT access token to authenticate with ClickHouse.
    *  JWT token authentication is supported in ClickHouse Cloud only.
+   *  Should not be set if {@link username} or {@link password} are provided.
    *  @default empty */
   access_token?: string
   /** The name of the application using the JS client.