Skip to content

Commit

Permalink
Correct the units in TURN servers expiry documentation (#2520)
Browse files Browse the repository at this point in the history
As shown elsewhere in client.ts, turnServersExpiry really is in
milliseconds rather than seconds. It seems that other libraries like
matrix-react-sdk were already expecting it to be in milliseconds
anyways, so it's just the documentation that was wrong.
  • Loading branch information
robintown authored Jul 12, 2022
1 parent 6fb40d4 commit 5112340
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6292,9 +6292,9 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
}

/**
* Get the unix timestamp (in seconds) at which the current
* Get the unix timestamp (in milliseconds) at which the current
* TURN credentials (from getTurnServers) expire
* @return {number} The expiry timestamp, in seconds, or null if no credentials
* @return {number} The expiry timestamp, in milliseconds, or null if no credentials
*/
public getTurnServersExpiry(): number | null {
return this.turnServersExpiry;
Expand Down

0 comments on commit 5112340

Please sign in to comment.