Correct the units in TURN servers expiry documentation (#2520)

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.
This commit is contained in:
Robin
2022-07-12 14:48:44 -04:00
committed by GitHub
parent 6fb40d465e
commit 5112340040
+2 -2
View File
@@ -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;