docs: demo project is runtime data documentation

packages/types/src/definitions/runtime/Offset.type.ts

@@ -5,11 +5,22 @@ export enum OffsetMode {
   Relative = 'relative',
 }
 
+/**
+ * Offset represents our current position in relation to the planned time
+ * a positive value means that we have added extra time to the expected end
+ * aka behind schedule
+ */
 export type Offset = {
-  absolute: number; // a positive value means that we are in over time aka behind schedule
+  /** Current absolute offset: accounts for planned times */
+  absolute: number;
+  /** Current relative offset: only counts for generated offset since start */
   relative: number;
+  /** Currently selected offset mode */
   mode: OffsetMode;
+  /** Timestamp of the expected start of the next flag */
   expectedGroupEnd: MaybeNumber;
+  /** Timestamp of the expected end of the current group */
   expectedRundownEnd: MaybeNumber;
+  /** Timestamp of the expected end of the loaded rundown */
   expectedFlagStart: MaybeNumber;
 };

packages/types/src/definitions/runtime/TimerState.type.ts

@@ -11,23 +11,26 @@ export enum TimerPhase {
   Pending = 'pending',
 }
 
+/**
+ * Gathers the current running timer state
+ */
 export type TimerState = {
-  /** time added by user, can be negative */
+  /** Additional time added to the running timer, can be negative */
   addedTime: number;
-  /** running countdown */
+  /** Current running timer countdown */
   current: MaybeNumber;
-  /** normalised duration of current event */
+  /** Total duration of the running event */
   duration: MaybeNumber;
-  /** elapsed time in current timer */
+  /** Time elapsed since the timer started */
   elapsed: MaybeNumber;
-  /** time we expect timer to finish */
+  /** Timestamp of the expected finish time */
   expectedFinish: MaybeNumber;
-  /** phase of of the running event */
+  /** Current phase of the running event */
   phase: TimerPhase;
-  /** playback state of the event */
+  /** Timer's playback state */
   playback: Playback;
-  /** used for roll mode */
+  /** Secondary timer, used to count to an event start in roll mode */
   secondaryTimer: MaybeNumber;
-  /** only if timer has already started */
+  /** Timestamp when the timer started */
   startedAt: MaybeNumber;
 };