diff --git a/desktop/src/types/ipc.ts b/desktop/src/types/ipc.ts index 2c137f4b7..25e98ceff 100644 --- a/desktop/src/types/ipc.ts +++ b/desktop/src/types/ipc.ts @@ -11,13 +11,14 @@ export interface AppUpdate { } export interface FolderWatch { - // TODO(MR): Is this needed + // TODO(MR): Is this needed? rootFolderName: string; collectionMapping: CollectionMapping; folderPath: string; syncedFiles: FolderWatchSyncedFile[]; ignoredFiles: string[]; } + export type CollectionMapping = "root" | "parent"; export interface FolderWatchSyncedFile { diff --git a/web/packages/next/types/ipc.ts b/web/packages/next/types/ipc.ts index db8012b8c..321fb2192 100644 --- a/web/packages/next/types/ipc.ts +++ b/web/packages/next/types/ipc.ts @@ -407,13 +407,15 @@ export interface FolderWatch { } /** - * The ways in which we can map nested files to collections when uploading or - * watching directories from the user's local file system. + * The ways in which directories are mapped to collection. + * + * This comes into play when we have nested directories that we are trying to + * upload or watch on the user's local file system. */ export type CollectionMapping = - /** Map everything to a single collection corresponding to the root directory */ + /** All files go into a single collection named after the root directory. */ | "root" - /** Map each file to a collection named after its parent directory */ + /** Each file goes to a collection named after its parent directory. */ | "parent"; /**