add docs in both stores

jellyfin · Feb 28, 2023 · 40d472a · 40d472a
1 parent b292820
commit 40d472a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/frontend/src/store/playbackManager.ts b/frontend/src/store/playbackManager.ts
@@ -1,3 +1,9 @@
+/**
+ * This store handles the state of the playback
+ *
+ * It must be used in an agnostic way to cover both local and remote playback.
+ * If you want to handle the state of the local player element, use playerElement store instead.
+ */
 import { reactive, ref, watch } from 'vue';
 import { shuffle, isNil, cloneDeep } from 'lodash-es';
 import {

diff --git a/frontend/src/store/playerElement.ts b/frontend/src/store/playerElement.ts
@@ -1,3 +1,9 @@
+/**
+ * This store handles the state of the local player.
+ *
+ * In the other part, playbackManager is suited to handle the playback state in
+ * an agnostic way, regardless of where the media is being played (remotely or locally)
+ */
 import { cloneDeep } from 'lodash-es';
 import { nextTick, reactive, watch } from 'vue';
 // @ts-expect-error - No types on libass-wasm