Add MarkEdit.getDirectoryPath for standard directories

Author: cyanzhong

README.md

@@ -19,7 +19,7 @@ Add `markedit-api` to your (TypeScript) project's devDependencies:
 ```json
 {
   "devDependencies": {
-    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.17.0"
+    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.18.0"
   }
 }
 ```
@@ -62,6 +62,8 @@ interface MarkEdit {
   getFileContent(path?: string): Promise<string | undefined>;
   // Get the information of a file.
   getFileInfo(path?: string): Promise<FileInfo | undefined>;
+  // Get the path of a standard directory.
+  getDirectoryPath(type: DirectoryType): string;
   // Get all items from the native pasteboard.
   getPasteboardItems(): Promise<PasteboardItem[]>;
   // Get the string from the native pasteboard.

index.d.ts

@@ -166,6 +166,13 @@ export interface MarkEdit {
    */
   getFileInfo(path?: string): Promise<FileInfo | undefined>;
 
+  /**
+   * Get the path of a standard directory.
+   * @param type The directory type.
+   * @returns The directory path.
+   */
+  getDirectoryPath(type: DirectoryType): string;
+
   /**
    * Get all items from the native pasteboard.
    * @returns The items from the native (general) pasteboard.
@@ -568,6 +575,11 @@ export type CreateFileOptions = {
   data?: string;
 };
 
+/**
+ * Represents standard directory types.
+ */
+export type DirectoryType = 'home' | 'documents' | 'library' | 'caches' | 'temporary';
+
 /**
  * Represents options to show the save panel.
  */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "markedit-api",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Type definitions for the latest MakrEdit API.",
   "main": "./index.cjs",
   "module": "./index.js",