Fix comment for useAuthorizationHeader config. (#4330)

matrix-org · Jul 28, 2024 · d32f398 · d32f398
1 parent 0f08c00
commit d32f398
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -324,10 +324,13 @@ export interface ICreateClientOpts {
  localTimeoutMs?: number;
 
  /**
- * Set to true to use
- * Authorization header instead of query param to send the access token to the server.
+ * Set to false to send the access token to the server via a query parameter rather
+ * than the Authorization HTTP header.
  *
- * Default false.
+ * Note that as of v1.11 of the Matrix spec, sending the access token via a query
+ * is deprecated.
+ *
+ * Default true.
  */
  useAuthorizationHeader?: boolean;