beenull/ente
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve docs

Browse source
This commit is contained in:
Manav Rathi 2024-04-18 13:23:20 +05:30
parent 230a8a72ab
commit 518d573add
No known key found for this signature in database
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
desktop/src/types/ipc.ts
View file

@ -11,13 +11,14 @@ export interface AppUpdate {
} }
export interface FolderWatch { export interface FolderWatch {
// TODO(MR): Is this needed // TODO(MR): Is this needed?
rootFolderName: string; rootFolderName: string;
collectionMapping: CollectionMapping; collectionMapping: CollectionMapping;
folderPath: string; folderPath: string;
syncedFiles: FolderWatchSyncedFile[]; syncedFiles: FolderWatchSyncedFile[];
ignoredFiles: string[]; ignoredFiles: string[];
} }
export type CollectionMapping = "root" | "parent"; export type CollectionMapping = "root" | "parent";
export interface FolderWatchSyncedFile { export interface FolderWatchSyncedFile {

10
web/packages/next/types/ipc.ts
View file

@ -407,13 +407,15 @@ export interface FolderWatch {
} }
/** /**
* The ways in which we can map nested files to collections when uploading or * The ways in which directories are mapped to collection.
* watching directories from the user's local file system. *
* 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 = 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" | "root"
/** Map each file to a collection named after its parent directory */ /** Each file goes to a collection named after its parent directory. */
| "parent"; | "parent";
/** /**