Skip to content

Commit d32f398

Browse files
authored
Fix comment for useAuthorizationHeader config. (#4330)
1 parent 0f08c00 commit d32f398

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/client.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -324,10 +324,13 @@ export interface ICreateClientOpts {
324324
localTimeoutMs?: number;
325325

326326
/**
327-
* Set to true to use
328-
* Authorization header instead of query param to send the access token to the server.
327+
* Set to false to send the access token to the server via a query parameter rather
328+
* than the Authorization HTTP header.
329329
*
330-
* Default false.
330+
* Note that as of v1.11 of the Matrix spec, sending the access token via a query
331+
* is deprecated.
332+
*
333+
* Default true.
331334
*/
332335
useAuthorizationHeader?: boolean;
333336

0 commit comments

Comments
 (0)