feat(player): make fileRoot option required for local files

BREAKING CHANGE: `fileRoot` option is required to play local files
larsrickert · Jun 18, 2022 · a0f1994 · a0f1994
1 parent 9bceb75
commit a0f1994
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git a/src/engines/file.ts b/src/engines/file.ts
@@ -10,9 +10,7 @@ import { isSubPath } from "../utils/fs";
 export const fileEngine: PlayerEngine = {
   source: "file",
   async isResponsible(query, { fileRoot }) {
-    if (fileRoot && !isSubPath(fileRoot, query)) {
-      return false;
-    }
+    if (!fileRoot || !isSubPath(fileRoot, query)) return false;
 
     // check if query is file path
     try {

diff --git a/src/types/player.ts b/src/types/player.ts
@@ -50,8 +50,8 @@ export interface PlayerOptions {
   /** Initial player volume for all tracks between 0 and 200. */
   initialVolume?: number;
   /**
-   * Path to the folder where local files should be playable from. If set, files outside this directory are refused to play.
-   * For security reasons, its recommended to set this option when playing local files with the player.
+   * Path to the folder where local files should be playable from. Must be set if local files should be playable.
+   * For security reasons files outside this directory are refused to play.
    *
    * @example
    * ```ts