Update the JSDoc

ClickHouse · Dec 16, 2024 · d06f0da · d06f0da
1 parent 0da6648
commit d06f0da
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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.