Skip to content

Commit

Permalink
Updated papi.d.ts with new Uri scheme documentation that I missed before
Browse files Browse the repository at this point in the history
  • Loading branch information
tjcouch-sil committed Feb 12, 2024
1 parent 5274dea commit dfae5a0
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions lib/papi-dts/papi.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3055,11 +3055,22 @@ declare module 'shared/data/file-system.model' {
* Represents a path in file system or other. Has a scheme followed by :// followed by a relative
* path. If no scheme is provided, the app scheme is used. Available schemes are as follows:
*
* - `app://` - goes to the app's home directory and into `.platform.bible` (platform-dependent)
* - `app://` - goes to the `.platform.bible` directory inside the user's home directory.
*
* - On Linux and Mac, this is `$HOME/.platform.bible`
* - On Windows, this is `%USERPROFILE%/.platform.bible`
* - Note: In development, `app://` always goes to `paranext-core/dev-appdata`
* - `cache://` - goes to the app's temporary file cache at `app://cache`
* - `data://` - goes to the app's data storage location at `app://data`
* - `resources://` - goes to the resources directory installed in the app
* - `file://` - an absolute file path from root
* - `resources://` - goes to the `resources` directory inside the install directory
*
* - Note: In development, `resources://` always goes to the repo root, `paranext-core`. Not all files
* are copied into the production `resources` folder, though. See `electron-builder.json5`'s
* `extraResources` for some that are copied.
* - `file://` - an absolute file path from drive root
*
* Note: projects are stored in the production version of `app://projects` regardless of whether you
* are in production or development
*/
export type Uri = string;
}
Expand Down

0 comments on commit dfae5a0

Please sign in to comment.