Skip to content

Commit 8619037

Browse files
committed
docs: Fix spacing and add clarity to TimeConductorBounds definition.
1 parent edbdb74 commit 8619037

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/api/time/TimeContext.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import { FIXED_MODE_KEY, MODES, REALTIME_MODE_KEY, TIME_CONTEXT_EVENTS } from '.
3434

3535
/**
3636
* @typedef {Object} TimeConductorBounds
37-
* @property {number } start The start time displayed by the time conductor
37+
* @property {number} start The start time displayed by the time conductor
3838
* in ms since epoch. Epoch determined by currently active time system
3939
* @property {number} end The end time displayed by the time conductor in ms
4040
* since epoch.
@@ -426,8 +426,8 @@ class TimeContext extends EventEmitter {
426426
/**
427427
* Set the time system of the TimeAPI.
428428
* Emits a "timeSystem" event with the new time system.
429-
* @param {TimeSystem | string} timeSystemOrKey
430-
* @param {TimeConductorBounds} bounds
429+
* @param {TimeSystem | string} timeSystemOrKey The time system to set, or its key
430+
* @param {TimeConductorBounds} [bounds] Optional bounds to set
431431
*/
432432
setTimeSystem(timeSystemOrKey, bounds) {
433433
if (timeSystemOrKey === undefined) {

0 commit comments

Comments
 (0)