From b2d491c5f5f81ecc9e40c2f3961794b8ebe88c75 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82=20Gadomski?= <xpfk.098@gmail.com>
Date: Thu, 5 Mar 2026 11:14:03 +0100
Subject: [PATCH] Added JSDocs to TrackMetadata type

---
 packages/ts-client/src/types.ts | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/packages/ts-client/src/types.ts b/packages/ts-client/src/types.ts
index 51062ce2..90c314c3 100644
--- a/packages/ts-client/src/types.ts
+++ b/packages/ts-client/src/types.ts
@@ -13,10 +13,17 @@ import type { AuthErrorReason } from './auth';
 import type { JoinErrorReason } from './guards';
 import type { ReconnectConfig } from './reconnection';
 
+/**
+ * Metadata attached to a track published by a peer.
+ * Sent over the signaling channel so other peers know what kind of track they're receiving.
+ * @category Tracks
+ */
 export type TrackMetadata = {
+  /** The kind of media this track carries. */
   type: 'camera' | 'microphone' | 'screenShareVideo' | 'screenShareAudio' | 'customVideo' | 'customAudio';
+  /** Whether the track is currently muted/disabled. */
   paused: boolean;
-  // track label used in recordings
+  /** The peer's display name, used in recordings. */
   displayName?: string;
 };