FileSystemService

Call

import { PLMainAPI } from "paperlib-api/api";

PLMainAPI.fileSystemService.methodname(...);

Avaliable Methods

getSystemPath

/**
 * Get the path of the given key.
 * @param {string} key - The key to get the path of.
 * @returns {string} - The path of the given key.
 */
getSystemPath(key: "home" | "appData" | "userData" | "sessionData" | "temp" | "exe" | "module" | "desktop" | "documents" | "downloads" | "music" | "pictures" | "videos" | "recent" | "logs" | "crashDumps", windowId: string): Promise<string>;

showFilePicker

/**
 * Show a file picker.
 * @returns {Promise<OpenDialogReturnValue>} The result of the file picker.
 */
showFilePicker(props?: Array<"openDirectory" | "multiSelections" | "showHiddenFiles" | "createDirectory" | "promptToCreate" | "noResolveAliases" | "treatPackageAsDirectory" | "dontAddToRecent">): Promise<OpenDialogReturnValue>;

showFolderPicker

/**
 * Show a folder picker.
 * @returns {Promise<OpenDialogReturnValue>} The result of the folder picker.
 */
showFolderPicker(): Promise<OpenDialogReturnValue>;

showSaveDialog

/**
 * Preview a file.
 * @param {string} fileURL - The URL of the file to preview.
 */
preview(fileURL: string): Promise<void>;

writeToFile

/**
 * Write some text to a file.
 * @param {string} filePath The path of the file to write to.
 * @param {string} text The text to write to the file.
 * @returns {void} Nothing.
 */
writeToFile(filePath: string, text: string): void;