From decc55524fcaefbcd64adb30ea5fdaf70e69a42a Mon Sep 17 00:00:00 2001 From: rxliuli Date: Fri, 9 Aug 2024 02:35:23 +0800 Subject: [PATCH] docs: trigger gh actions --- packages/website/docs/en-US/dev/index.md | 13 - .../en-US/dev/joplin-api/classes/Config.md | 33 - .../en-US/dev/joplin-api/classes/EventApi.md | 149 ---- .../en-US/dev/joplin-api/classes/FolderApi.md | 189 ----- .../dev/joplin-api/classes/FolderExtApi.md | 85 -- .../en-US/dev/joplin-api/classes/JoplinApi.md | 35 - .../joplin-api/classes/JoplinApiGenerator.md | 173 ---- .../dev/joplin-api/classes/NoteActionApi.md | 97 --- .../en-US/dev/joplin-api/classes/NoteApi.md | 215 ----- .../dev/joplin-api/classes/NoteExtApi.md | 87 -- .../en-US/dev/joplin-api/classes/PageUtil.md | 66 -- .../joplin-api/classes/ResourceActionApi.md | 93 --- .../dev/joplin-api/classes/ResourceApi.md | 200 ----- .../en-US/dev/joplin-api/classes/SearchApi.md | 43 - .../en-US/dev/joplin-api/classes/TagApi.md | 189 ----- .../joplin-api/enumerations/NoteActionEnum.md | 33 - .../enumerations/ResourceActionEnum.md | 43 - .../dev/joplin-api/enumerations/TypeEnum.md | 153 ---- .../dev/joplin-api/functions/joplinDataApi.md | 17 - .../docs/en-US/dev/joplin-api/globals.md | 79 -- .../docs/en-US/dev/joplin-api/index.md | 7 - .../en-US/dev/joplin-api/interfaces/Api.md | 113 --- .../joplin-api/interfaces/BaseProperties.md | 113 --- .../dev/joplin-api/interfaces/CommonType.md | 13 - .../joplin-api/interfaces/EventProperties.md | 73 -- .../dev/joplin-api/interfaces/FieldsParam.md | 17 - .../interfaces/FolderListRecursionGetTree.md | 13 - .../joplin-api/interfaces/FolderProperties.md | 159 ---- .../joplin-api/interfaces/NoteProperties.md | 403 ---------- .../dev/joplin-api/interfaces/PageParam.md | 47 -- .../dev/joplin-api/interfaces/PageRes.md | 33 - .../interfaces/ResourceProperties.md | 197 ----- .../dev/joplin-api/type-aliases/ApiConfig.md | 9 - .../joplin-api/type-aliases/EventGetRes.md | 9 - .../joplin-api/type-aliases/EventListRes.md | 9 - .../type-aliases/FolderCreateRes.md | 9 - .../joplin-api/type-aliases/FolderGetRes.md | 9 - .../type-aliases/FolderListAllRes.md | 19 - .../joplin-api/type-aliases/FolderListRes.md | 9 - .../type-aliases/FolderUpdateRes.md | 9 - .../joplin-api/type-aliases/NoteCreateRes.md | 9 - .../dev/joplin-api/type-aliases/NoteGetRes.md | 9 - .../joplin-api/type-aliases/NoteTagRelated.md | 19 - .../joplin-api/type-aliases/NoteUpdateRes.md | 9 - .../joplin-api/type-aliases/ResourceGetRes.md | 9 - .../dev/joplin-api/type-aliases/TagGetRes.md | 9 - .../joplin-api/type-aliases/TagProperties.md | 9 - .../dev/joplin-api/variables/actionApi.md | 9 - .../en-US/dev/joplin-api/variables/ajax.md | 9 - .../en-US/dev/joplin-api/variables/config.md | 11 - .../dev/joplin-api/variables/eventApi.md | 9 - .../dev/joplin-api/variables/folderApi.md | 9 - .../dev/joplin-api/variables/folderExtApi.md | 9 - .../dev/joplin-api/variables/joplinApi.md | 9 - .../dev/joplin-api/variables/noteActionApi.md | 9 - .../en-US/dev/joplin-api/variables/noteApi.md | 9 - .../dev/joplin-api/variables/noteExtApi.md | 9 - .../joplin-api/variables/resourceActionApi.md | 9 - .../dev/joplin-api/variables/resourceApi.md | 9 - .../dev/joplin-api/variables/searchApi.md | 9 - .../en-US/dev/joplin-api/variables/tagApi.md | 9 - .../joplin-plugin-api/enumerations/AppType.md | 33 - .../enumerations/ContentScriptType.md | 191 ----- .../enumerations/FileSystemItem.md | 23 - .../enumerations/ImportModuleOutputFormat.md | 23 - .../enumerations/MenuItemLocation.md | 132 ---- .../enumerations/ModelType.md | 163 ---- .../enumerations/SettingItemSubType.md | 33 - .../enumerations/SettingItemType.md | 63 -- .../enumerations/SettingStorage.md | 23 - .../enumerations/ToolbarButtonLocation.md | 27 - .../functions/isContextMenuItemLocation.md | 17 - .../en-US/dev/joplin-plugin-api/globals.md | 58 -- .../docs/en-US/dev/joplin-plugin-api/index.md | 7 - .../interfaces/ButtonSpec.md | 37 - .../CodeMirrorContentScriptModule.md | 65 -- .../interfaces/CodeMirrorControl.md | 149 ---- .../joplin-plugin-api/interfaces/Command.md | 98 --- .../interfaces/ContentScriptContext.md | 41 - .../interfaces/ContentScriptModule.md | 49 -- .../ContentScriptModuleLoadedEvent.md | 13 - .../interfaces/CreateMenuItemOptions.md | 13 - .../interfaces/DialogResult.md | 23 - .../interfaces/Disposable.md | 3 - .../interfaces/EditorCommand.md | 23 - .../interfaces/ExportContext.md | 35 - .../interfaces/ExportModule.md | 159 ---- .../interfaces/ExportOptions.md | 53 -- .../interfaces/ImportContext.md | 33 - .../interfaces/ImportModule.md | 97 --- .../MarkdownItContentScriptModule.md | 67 -- .../joplin-plugin-api/interfaces/MenuItem.md | 77 -- .../joplin-plugin-api/interfaces/Rectangle.md | 43 - .../joplin-plugin-api/interfaces/Script.md | 21 - .../interfaces/SettingItem.md | 193 ----- .../interfaces/SettingSection.md | 43 - .../dev/joplin-plugin-api/interfaces/Size.md | 23 - .../interfaces/VersionInfo.md | 43 - .../type-aliases/ButtonId.md | 9 - .../joplin-plugin-api/type-aliases/Path.md | 15 - .../type-aliases/PostMessageHandler.md | 17 - .../type-aliases/ViewHandle.md | 9 - .../joplin-plugin-api/variables/default.md | 9 - .../dev/jpl-vite/api/enumerations/AppType.md | 33 - .../api/enumerations/ContentScriptType.md | 191 ----- .../api/enumerations/FileSystemItem.md | 23 - .../enumerations/ImportModuleOutputFormat.md | 23 - .../api/enumerations/MenuItemLocation.md | 132 ---- .../jpl-vite/api/enumerations/ModelType.md | 163 ---- .../api/enumerations/SettingItemSubType.md | 33 - .../api/enumerations/SettingItemType.md | 63 -- .../api/enumerations/SettingStorage.md | 23 - .../api/enumerations/ToolbarButtonLocation.md | 27 - .../functions/isContextMenuItemLocation.md | 17 - .../docs/en-US/dev/jpl-vite/api/index.md | 60 -- .../dev/jpl-vite/api/interfaces/ButtonSpec.md | 37 - .../CodeMirrorContentScriptModule.md | 65 -- .../api/interfaces/CodeMirrorControl.md | 149 ---- .../dev/jpl-vite/api/interfaces/Command.md | 98 --- .../api/interfaces/ContentScriptContext.md | 41 - .../api/interfaces/ContentScriptModule.md | 49 -- .../ContentScriptModuleLoadedEvent.md | 13 - .../api/interfaces/CreateMenuItemOptions.md | 13 - .../jpl-vite/api/interfaces/DialogResult.md | 23 - .../dev/jpl-vite/api/interfaces/Disposable.md | 3 - .../jpl-vite/api/interfaces/EditorCommand.md | 23 - .../jpl-vite/api/interfaces/ExportContext.md | 35 - .../jpl-vite/api/interfaces/ExportModule.md | 159 ---- .../jpl-vite/api/interfaces/ExportOptions.md | 53 -- .../jpl-vite/api/interfaces/ImportContext.md | 33 - .../jpl-vite/api/interfaces/ImportModule.md | 97 --- .../MarkdownItContentScriptModule.md | 67 -- .../dev/jpl-vite/api/interfaces/MenuItem.md | 77 -- .../dev/jpl-vite/api/interfaces/Rectangle.md | 43 - .../dev/jpl-vite/api/interfaces/Script.md | 21 - .../jpl-vite/api/interfaces/SettingItem.md | 193 ----- .../jpl-vite/api/interfaces/SettingSection.md | 43 - .../en-US/dev/jpl-vite/api/interfaces/Size.md | 23 - .../jpl-vite/api/interfaces/VersionInfo.md | 43 - .../dev/jpl-vite/api/type-aliases/ButtonId.md | 9 - .../dev/jpl-vite/api/type-aliases/Path.md | 15 - .../api/type-aliases/PostMessageHandler.md | 17 - .../jpl-vite/api/type-aliases/ViewHandle.md | 9 - .../dev/jpl-vite/api/variables/joplin.md | 9 - .../website/docs/en-US/dev/jpl-vite/index.md | 11 - .../jpl-vite/index/functions/defineConfig.md | 17 - .../dev/jpl-vite/index/functions/getEnv.md | 13 - .../docs/en-US/dev/jpl-vite/index/index.md | 15 - .../jpl-vite/index/interfaces/PluginConfig.md | 245 ------ .../index/interfaces/ResolvedPluginConfig.md | 255 ------ .../functions/defineExtensionMessaging.md | 21 - .../en-US/dev/jpl-vite/messaging/index.md | 9 - .../docs/en-US/dev/jpl-vite/modules.md | 10 - .../docs/en-US/dev/jpl-vite/webview/index.md | 9 - .../jpl-vite/webview/variables/webviewApi.md | 9 - packages/website/docs/en-US/dev/packages.md | 7 - .../docs/en-US/dev/typedoc-sidebar.json | 747 ------------------ 157 files changed, 9332 deletions(-) delete mode 100644 packages/website/docs/en-US/dev/index.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/Config.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/EventApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/FolderApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/FolderExtApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/JoplinApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/JoplinApiGenerator.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/NoteActionApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/NoteApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/NoteExtApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/PageUtil.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/ResourceActionApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/ResourceApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/SearchApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/classes/TagApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/enumerations/NoteActionEnum.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/enumerations/ResourceActionEnum.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/enumerations/TypeEnum.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/functions/joplinDataApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/globals.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/index.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/Api.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/BaseProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/CommonType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/EventProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/FieldsParam.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/FolderListRecursionGetTree.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/FolderProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/NoteProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/PageParam.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/PageRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/interfaces/ResourceProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/ApiConfig.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/EventGetRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/EventListRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderCreateRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderGetRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListAllRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderUpdateRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteCreateRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteGetRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteTagRelated.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteUpdateRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/ResourceGetRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/TagGetRes.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/type-aliases/TagProperties.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/actionApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/ajax.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/config.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/eventApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/folderApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/folderExtApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/joplinApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/noteActionApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/noteApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/noteExtApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/resourceActionApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/resourceApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/searchApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-api/variables/tagApi.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/AppType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ContentScriptType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/FileSystemItem.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ImportModuleOutputFormat.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/MenuItemLocation.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ModelType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemSubType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemType.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingStorage.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ToolbarButtonLocation.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/functions/isContextMenuItemLocation.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/globals.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/index.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ButtonSpec.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorControl.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Command.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptContext.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModuleLoadedEvent.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CreateMenuItemOptions.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/DialogResult.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Disposable.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/EditorCommand.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportContext.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportModule.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportOptions.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportContext.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportModule.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MarkdownItContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MenuItem.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Rectangle.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Script.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingItem.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingSection.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Size.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/VersionInfo.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ButtonId.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/Path.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/PostMessageHandler.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ViewHandle.md delete mode 100644 packages/website/docs/en-US/dev/joplin-plugin-api/variables/default.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/AppType.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ContentScriptType.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/FileSystemItem.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ImportModuleOutputFormat.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/MenuItemLocation.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ModelType.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemSubType.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemType.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingStorage.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ToolbarButtonLocation.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/functions/isContextMenuItemLocation.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/index.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ButtonSpec.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorControl.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Command.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptContext.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModuleLoadedEvent.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CreateMenuItemOptions.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/DialogResult.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Disposable.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/EditorCommand.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportContext.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportModule.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportOptions.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportContext.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportModule.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MarkdownItContentScriptModule.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MenuItem.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Rectangle.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Script.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingItem.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingSection.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Size.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/interfaces/VersionInfo.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ButtonId.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/Path.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/PostMessageHandler.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ViewHandle.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/api/variables/joplin.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index/functions/defineConfig.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index/functions/getEnv.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index/index.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index/interfaces/PluginConfig.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/index/interfaces/ResolvedPluginConfig.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/messaging/functions/defineExtensionMessaging.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/messaging/index.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/modules.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/webview/index.md delete mode 100644 packages/website/docs/en-US/dev/jpl-vite/webview/variables/webviewApi.md delete mode 100644 packages/website/docs/en-US/dev/packages.md delete mode 100644 packages/website/docs/en-US/dev/typedoc-sidebar.json diff --git a/packages/website/docs/en-US/dev/index.md b/packages/website/docs/en-US/dev/index.md deleted file mode 100644 index 084850fa..00000000 --- a/packages/website/docs/en-US/dev/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# joplin-utils - -> [中文](https://joplin-utils.rxliuli.com/zh-CN/) - -Some joplin peripheral tools created by me. Since the functions are in the same category and are related, they are managed using monorepo. - -- [joplin-vscode-plugin ![install](https://img.shields.io/visual-studio-marketplace/i/rxliuli.joplin-vscode-plugin)](https://marketplace.visualstudio.com/items?itemName=rxliuli.joplin-vscode-plugin&ssr=false#overview): joplin's vscode plugin -- [joplin-blog](https://www.npmjs.com/package/joplin-blog): export blog/wiki from Joplin as data source -- [joplin-search-integration](https://chrome.google.com/webstore/detail/joplin-search-integration/mcjkdcifkhjenpfjacnbhpdcnjknjkhj): Integrate joplin notes search results in Google/Bing/Baidu search -- [joplin-batch-web](https://joplin-utils.rxliuli.com/joplin-batch-web/): Process some batch operations that Joplin does not support, and display them in the form of a visual interface -- [joplin-api](https://www.npmjs.com/package/joplin-api): api wrapper for Joplin for web/nodejs, and the basis for the above results - -If the above tools are helpful to you, you can give me a star diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/Config.md b/packages/website/docs/en-US/dev/joplin-api/classes/Config.md deleted file mode 100644 index ec8b7e0d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/Config.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / Config - -# Class: Config - -## Constructors - -### new Config() - -> **new Config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -## Properties - -### baseUrl - -> **baseUrl**: `string` = `'http://127.0.0.1:41184'` - -#### Defined in - -[util/config.ts:2](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/config.ts#L2) - ---- - -### token - -> **token**: `string` = `''` - -#### Defined in - -[util/config.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/config.ts#L3) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/EventApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/EventApi.md deleted file mode 100644 index a89fa70a..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/EventApi.md +++ /dev/null @@ -1,149 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / EventApi - -# Class: EventApi - -## Link - -https://joplinapp.org/api/references/rest_api/#events - -## Constructors - -### new EventApi() - -> **new EventApi**(`ajax`): [`EventApi`](EventApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`EventApi`](EventApi.md) - -#### Defined in - -[api/EventApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L23) - -## Methods - -### get() - -#### Link - -https://joplinapp.org/api/references/rest_api/#get-events-id - -#### Param - -#### get(id) - -> **get**(`id`): `Promise`\<[`EventGetRes`](../type-aliases/EventGetRes.md)\> - -##### Parameters - -• **id**: `number` - -##### Returns - -`Promise`\<[`EventGetRes`](../type-aliases/EventGetRes.md)\> - -##### Link - -https://joplinapp.org/api/references/rest_api/#get-events-id - -##### Param - -##### Defined in - -[api/EventApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L42) - -#### get(id, fields) - -> **get**\<`K`\>(`id`, `fields`): `Promise`\<`Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Type Parameters - -• **K** _extends_ keyof [`EventProperties`](../interfaces/EventProperties.md) - -##### Parameters - -• **id**: `number` - -• **fields**: `K`[] - -##### Returns - -`Promise`\<`Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Link - -https://joplinapp.org/api/references/rest_api/#get-events-id - -##### Param - -##### Defined in - -[api/EventApi.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L43) - ---- - -### list() - -#### Link - -https://joplinapp.org/api/references/rest_api/#get-events - -#### Param - -#### list(param) - -> **list**(`param`?): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`EventListRes`](../type-aliases/EventListRes.md)\> & `object`\> - -##### Parameters - -• **param?** - -• **param.cursor?**: `string` - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`EventListRes`](../type-aliases/EventListRes.md)\> & `object`\> - -##### Link - -https://joplinapp.org/api/references/rest_api/#get-events - -##### Param - -##### Defined in - -[api/EventApi.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L25) - -#### list(param) - -> **list**\<`K`\>(`param`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `K`\>\> & `object`\> - -##### Type Parameters - -• **K** _extends_ keyof [`EventProperties`](../interfaces/EventProperties.md) - -##### Parameters - -• **param** - -• **param.cursor?**: `string` - -• **param.fields**: `K`[] - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `K`\>\> & `object`\> - -##### Link - -https://joplinapp.org/api/references/rest_api/#get-events - -##### Param - -##### Defined in - -[api/EventApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L26) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/FolderApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/FolderApi.md deleted file mode 100644 index 179fe745..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/FolderApi.md +++ /dev/null @@ -1,189 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderApi - -# Class: FolderApi - -目录相关 api - -## Constructors - -### new FolderApi() - -> **new FolderApi**(`ajax`): [`FolderApi`](FolderApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`FolderApi`](FolderApi.md) - -#### Defined in - -[api/FolderApi.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L21) - -## Methods - -### create() - -> **create**(`param`): `Promise`\<[`FolderCreateRes`](../type-aliases/FolderCreateRes.md)\> - -#### Parameters - -• **param**: `RequiredField`\<`Partial`\<[`FolderProperties`](../interfaces/FolderProperties.md)\>, `"title"`\> - -#### Returns - -`Promise`\<[`FolderCreateRes`](../type-aliases/FolderCreateRes.md)\> - -#### Defined in - -[api/FolderApi.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L44) - ---- - -### get() - -> **get**(`id`): `Promise`\<[`FolderGetRes`](../type-aliases/FolderGetRes.md)\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<[`FolderGetRes`](../type-aliases/FolderGetRes.md)\> - -#### Defined in - -[api/FolderApi.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L40) - ---- - -### list() - -#### list(undefined) - -> **list**(): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`FolderListRes`](../type-aliases/FolderListRes.md)\>\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`FolderListRes`](../type-aliases/FolderListRes.md)\>\> - -##### Defined in - -[api/FolderApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L23) - -#### list(pageParam) - -> **list**\<`K`\>(`pageParam`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `K`\>\>\> - -##### Type Parameters - -• **K** _extends_ keyof [`FolderProperties`](../interfaces/FolderProperties.md) = `"id"` \| `"title"` \| `"parent_id"` - -##### Parameters - -• **pageParam**: [`PageParam`](../interfaces/PageParam.md)\<[`FolderProperties`](../interfaces/FolderProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `K`\>\>\> - -##### Defined in - -[api/FolderApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L24) - ---- - -### listAll() - -> **listAll**(): `Promise`\<[`FolderListAllRes`](../type-aliases/FolderListAllRes.md)[]\> - -使用特殊的 as_tree 参数来恢复旧的行为 - -#### Returns - -`Promise`\<[`FolderListAllRes`](../type-aliases/FolderListAllRes.md)[]\> - -#### Defined in - -[api/FolderApi.ts:34](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L34) - ---- - -### notesByFolderId() - -#### notesByFolderId(id) - -> **notesByFolderId**(`id`): `Promise`\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)[]\> - -##### Parameters - -• **id**: `string` - -##### Returns - -`Promise`\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)[]\> - -##### Defined in - -[api/FolderApi.ts:57](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L57) - -#### notesByFolderId(id, fields) - -> **notesByFolderId**\<`K`\>(`id`, `fields`): `Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\>[]\> - -##### Type Parameters - -• **K** _extends_ keyof [`NoteProperties`](../interfaces/NoteProperties.md) = `"id"` \| `"title"` \| `"parent_id"` - -##### Parameters - -• **id**: `string` - -• **fields**: `K`[] - -##### Returns - -`Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\>[]\> - -##### Defined in - -[api/FolderApi.ts:58](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L58) - ---- - -### remove() - -> **remove**(`id`): `Promise`\<`string`\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[api/FolderApi.ts:53](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L53) - ---- - -### update() - -> **update**(`param`): `Promise`\<[`FolderUpdateRes`](../type-aliases/FolderUpdateRes.md)\> - -#### Parameters - -• **param**: `RequiredField`\<`Partial`\<[`FolderProperties`](../interfaces/FolderProperties.md)\>, `"id"`\> - -#### Returns - -`Promise`\<[`FolderUpdateRes`](../type-aliases/FolderUpdateRes.md)\> - -#### Defined in - -[api/FolderApi.ts:48](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L48) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/FolderExtApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/FolderExtApi.md deleted file mode 100644 index 4ee23bcb..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/FolderExtApi.md +++ /dev/null @@ -1,85 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderExtApi - -# Class: FolderExtApi - -## Constructors - -### new FolderExtApi() - -> **new FolderExtApi**(`ajax`): [`FolderExtApi`](FolderExtApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`FolderExtApi`](FolderExtApi.md) - -#### Defined in - -[api/FolderExtApi.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L9) - -## Methods - -### move() - -> **move**(`id`, `parentId`): `Promise`\<`void`\> - -将目录移动到另一个目录中 - -#### Parameters - -• **id**: `string` - -• **parentId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/FolderExtApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L42) - ---- - -### path() - -> **path**(`id`): `Promise`\<[`FolderGetRes`](../type-aliases/FolderGetRes.md)[]\> - -获取一个目录的路径目录列表 - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<[`FolderGetRes`](../type-aliases/FolderGetRes.md)[]\> - -#### Defined in - -[api/FolderExtApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L26) - ---- - -### rename() - -> **rename**(`id`, `title`): `Promise`\<[`FolderUpdateRes`](../type-aliases/FolderUpdateRes.md)\> - -重命名目录 - -#### Parameters - -• **id**: `string` - -• **title**: `string` - -#### Returns - -`Promise`\<[`FolderUpdateRes`](../type-aliases/FolderUpdateRes.md)\> - -#### Defined in - -[api/FolderExtApi.ts:18](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L18) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApi.md deleted file mode 100644 index ce84ee72..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApi.md +++ /dev/null @@ -1,35 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / JoplinApi - -# Class: JoplinApi - -## Constructors - -### new JoplinApi() - -> **new JoplinApi**(`ajax`): [`JoplinApi`](JoplinApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`JoplinApi`](JoplinApi.md) - -#### Defined in - -[api/JoplinApi.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApi.ts#L4) - -## Methods - -### ping() - -> **ping**(): `Promise`\<`boolean`\> - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[api/JoplinApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApi.ts#L6) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApiGenerator.md b/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApiGenerator.md deleted file mode 100644 index 5d8b3934..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/JoplinApiGenerator.md +++ /dev/null @@ -1,173 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / JoplinApiGenerator - -# Class: JoplinApiGenerator - -## Constructors - -### new JoplinApiGenerator() - -> **new JoplinApiGenerator**(): [`JoplinApiGenerator`](JoplinApiGenerator.md) - -#### Returns - -[`JoplinApiGenerator`](JoplinApiGenerator.md) - -## Properties - -### ajax - -> `readonly` **ajax**: `Ajax` - -#### Defined in - -[api/JoplinApiGenerator.ts:36](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L36) - ---- - -### eventApi - -> `readonly` **eventApi**: [`EventApi`](EventApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:47](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L47) - ---- - -### folderApi - -> `readonly` **folderApi**: [`FolderApi`](FolderApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L37) - ---- - -### folderExtApi - -> `readonly` **folderExtApi**: [`FolderExtApi`](FolderExtApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:38](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L38) - ---- - -### joplinApi - -> `readonly` **joplinApi**: [`JoplinApi`](JoplinApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:39](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L39) - ---- - -### noteActionApi - -> `readonly` **noteActionApi**: [`NoteActionApi`](NoteActionApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L40) - ---- - -### noteApi - -> `readonly` **noteApi**: [`NoteApi`](NoteApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:41](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L41) - ---- - -### noteExtApi - -> `readonly` **noteExtApi**: [`NoteExtApi`](NoteExtApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L42) - ---- - -### resourceActionApi - -> `readonly` **resourceActionApi**: [`ResourceActionApi`](ResourceActionApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L43) - ---- - -### resourceApi - -> `readonly` **resourceApi**: [`ResourceApi`](ResourceApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L44) - ---- - -### searchApi - -> `readonly` **searchApi**: [`SearchApi`](SearchApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:45](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L45) - ---- - -### tagApi - -> `readonly` **tagApi**: [`TagApi`](TagApi.md) - -#### Defined in - -[api/JoplinApiGenerator.ts:46](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L46) - -## Accessors - -### baseUrl - -> `get` **baseUrl**(): `string` - -> `set` **baseUrl**(`baseUrl`): `void` - -#### Parameters - -• **baseUrl**: `string` - -#### Returns - -`string` - -#### Defined in - -[api/JoplinApiGenerator.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L24) - ---- - -### token - -> `get` **token**(): `string` - -> `set` **token**(`token`): `void` - -#### Parameters - -• **token**: `string` - -#### Returns - -`string` - -#### Defined in - -[api/JoplinApiGenerator.ts:32](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L32) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/NoteActionApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/NoteActionApi.md deleted file mode 100644 index 20607a88..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/NoteActionApi.md +++ /dev/null @@ -1,97 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteActionApi - -# Class: NoteActionApi - -## Constructors - -### new NoteActionApi() - -> **new NoteActionApi**(`ajax`): [`NoteActionApi`](NoteActionApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`NoteActionApi`](NoteActionApi.md) - -#### Defined in - -[api/NoteActionApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L10) - -## Methods - -### isWatch() - -> **isWatch**(`noteId`): `Promise`\<`boolean`\> - -#### Parameters - -• **noteId**: `string` - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[api/NoteActionApi.ts:28](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L28) - ---- - -### ~~noteIsWatched()~~ - -> **noteIsWatched**(`noteId`): `Promise`\<`boolean`\> - -#### Parameters - -• **noteId**: `string` - -#### Returns - -`Promise`\<`boolean`\> - -#### Deprecated - -已废弃，请使用 [isWatch](NoteActionApi.md#iswatch) - -#### Defined in - -[api/NoteActionApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L24) - ---- - -### openAndWatch() - -> **openAndWatch**(`noteId`): `Promise`\<`void`\> - -#### Parameters - -• **noteId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/NoteActionApi.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L12) - ---- - -### stopWatching() - -> **stopWatching**(`noteId`): `Promise`\<`void`\> - -#### Parameters - -• **noteId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/NoteActionApi.ts:16](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L16) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/NoteApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/NoteApi.md deleted file mode 100644 index 907f4095..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/NoteApi.md +++ /dev/null @@ -1,215 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteApi - -# Class: NoteApi - -TODO 可以考虑使用 fields() 方法设置然后产生一个新的 Api 实例 - -## Constructors - -### new NoteApi() - -> **new NoteApi**(`ajax`): [`NoteApi`](NoteApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`NoteApi`](NoteApi.md) - -#### Defined in - -[api/NoteApi.ts:20](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L20) - -## Methods - -### create() - -> **create**(`param`): `Promise`\<[`NoteCreateRes`](../type-aliases/NoteCreateRes.md)\> - -#### Parameters - -• **param**: `RequiredField`\<`Partial`\<[`NoteProperties`](../interfaces/NoteProperties.md)\>, `"title"`\> - -#### Returns - -`Promise`\<[`NoteCreateRes`](../type-aliases/NoteCreateRes.md)\> - -#### Defined in - -[api/NoteApi.ts:39](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L39) - ---- - -### get() - -#### get(id) - -> **get**(`id`): `Promise`\<[`NoteGetRes`](../type-aliases/NoteGetRes.md) & [`CommonType`](../interfaces/CommonType.md)\> - -##### Parameters - -• **id**: `string` - -##### Returns - -`Promise`\<[`NoteGetRes`](../type-aliases/NoteGetRes.md) & [`CommonType`](../interfaces/CommonType.md)\> - -##### Defined in - -[api/NoteApi.ts:30](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L30) - -#### get(id, fields) - -> **get**\<`K`\>(`id`, `fields`?): `Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Type Parameters - -• **K** _extends_ keyof [`NoteProperties`](../interfaces/NoteProperties.md) = `"id"` \| `"title"` \| `"parent_id"` - -##### Parameters - -• **id**: `string` - -• **fields?**: `K`[] - -##### Returns - -`Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Defined in - -[api/NoteApi.ts:31](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L31) - ---- - -### list() - -#### list(undefined) - -> **list**(): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)\>\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)\>\> - -##### Defined in - -[api/NoteApi.ts:22](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L22) - -#### list(pageParam) - -> **list**\<`K`\>(`pageParam`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\>\>\> - -##### Type Parameters - -• **K** _extends_ keyof [`NoteProperties`](../interfaces/NoteProperties.md) = `"id"` \| `"title"` \| `"parent_id"` - -##### Parameters - -• **pageParam**: [`PageParam`](../interfaces/PageParam.md)\<[`NoteProperties`](../interfaces/NoteProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\>\>\> - -##### Defined in - -[api/NoteApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L23) - ---- - -### remove() - -> **remove**(`id`): `Promise`\<`void`\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/NoteApi.ts:48](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L48) - ---- - -### resourcesById() - -#### resourcesById(id) - -> **resourcesById**(`id`): `Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)[]\> - -##### Parameters - -• **id**: `string` - -##### Returns - -`Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)[]\> - -##### Defined in - -[api/NoteApi.ts:59](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L59) - -#### resourcesById(id, fields) - -> **resourcesById**\<`K`\>(`id`, `fields`): `Promise`\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)[]\> - -##### Type Parameters - -• **K** _extends_ keyof [`ResourceProperties`](../interfaces/ResourceProperties.md) = `"id"` \| `"title"` - -##### Parameters - -• **id**: `string` - -• **fields**: `K`[] - -##### Returns - -`Promise`\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)[]\> - -##### Defined in - -[api/NoteApi.ts:60](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L60) - ---- - -### tagsById() - -> **tagsById**(`id`): `Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)[]\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)[]\> - -#### Defined in - -[api/NoteApi.ts:52](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L52) - ---- - -### update() - -> **update**(`param`): `Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -#### Parameters - -• **param**: `RequiredField`\<`Partial`\<[`NoteProperties`](../interfaces/NoteProperties.md)\>, `"id"`\> - -#### Returns - -`Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -#### Defined in - -[api/NoteApi.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteApi.ts#L43) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/NoteExtApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/NoteExtApi.md deleted file mode 100644 index c8612c9e..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/NoteExtApi.md +++ /dev/null @@ -1,87 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteExtApi - -# Class: NoteExtApi - -## Constructors - -### new NoteExtApi() - -> **new NoteExtApi**(`ajax`): [`NoteExtApi`](NoteExtApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`NoteExtApi`](NoteExtApi.md) - -#### Defined in - -[api/NoteExtApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteExtApi.ts#L10) - -## Methods - -### move() - -> **move**(`id`, `parentId`): `Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -将笔记移动到指定目录 - -#### Parameters - -• **id**: `string` - -• **parentId**: `string` - -#### Returns - -`Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -#### Defined in - -[api/NoteExtApi.ts:28](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteExtApi.ts#L28) - ---- - -### rename() - -> **rename**(`id`, `title`): `Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -重命名笔记 - -#### Parameters - -• **id**: `string` - -• **title**: `string` - -#### Returns - -`Promise`\<[`NoteUpdateRes`](../type-aliases/NoteUpdateRes.md)\> - -#### Defined in - -[api/NoteExtApi.ts:19](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteExtApi.ts#L19) - ---- - -### toggleTodo() - -> **toggleTodo**(`id`, `completed`?): `Promise`\<`void`\> - -切换 to-do 的状态 - -#### Parameters - -• **id**: `string` - -• **completed?**: `IntBool` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/NoteExtApi.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteExtApi.ts#L37) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/PageUtil.md b/packages/website/docs/en-US/dev/joplin-api/classes/PageUtil.md deleted file mode 100644 index 4cc589d3..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/PageUtil.md +++ /dev/null @@ -1,66 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / PageUtil - -# Class: PageUtil - -## Constructors - -### new PageUtil() - -> **new PageUtil**(): [`PageUtil`](PageUtil.md) - -#### Returns - -[`PageUtil`](PageUtil.md) - -## Methods - -### pageToAllList() - -#### pageToAllList(fn, pageParam) - -> `static` **pageToAllList**\<`F`\>(`fn`, `pageParam`?): `Promise`\<`PageResValueType`\<`ReturnType`\<`F`\>\>[]\> - -循环获取所有分页的数据 -每次都获取最大分页数量，尽可能减少请求次数 - -##### Type Parameters - -• **F** _extends_ (`pageParam`) => `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`any`\>\> - -##### Parameters - -• **fn**: `F` - -• **pageParam?**: `Omit`\<`Parameters`\<`F`\>\[`0`\], `"page"` \| `"limit"`\> - -##### Returns - -`Promise`\<`PageResValueType`\<`ReturnType`\<`F`\>\>[]\> - -##### Defined in - -[util/PageUtil.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/PageUtil.ts#L21) - -#### pageToAllList(fn, pageParam) - -> `static` **pageToAllList**\<`K`, `F`\>(`fn`, `pageParam`): `Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)[]\> - -##### Type Parameters - -• **K** _extends_ keyof [`NoteProperties`](../interfaces/NoteProperties.md) - -• **F** _extends_ (`pageParam`) => `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\>\> - -##### Parameters - -• **fn**: `F` - -• **pageParam**: `object` & [`PageParam`](../interfaces/PageParam.md)\<[`NoteProperties`](../interfaces/NoteProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -##### Returns - -`Promise`\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)[]\> - -##### Defined in - -[util/PageUtil.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/PageUtil.ts#L25) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/ResourceActionApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/ResourceActionApi.md deleted file mode 100644 index 16fe1e0c..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/ResourceActionApi.md +++ /dev/null @@ -1,93 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ResourceActionApi - -# Class: ResourceActionApi - -## Constructors - -### new ResourceActionApi() - -> **new ResourceActionApi**(`ajax`): [`ResourceActionApi`](ResourceActionApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`ResourceActionApi`](ResourceActionApi.md) - -#### Defined in - -[api/ResourceActionApi.ts:11](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L11) - -## Methods - -### noteIsWatched() - -> **noteIsWatched**(`resourceId`): `Promise`\<`boolean`\> - -#### Parameters - -• **resourceId**: `string` - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[api/ResourceActionApi.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L25) - ---- - -### openAndWatch() - -> **openAndWatch**(`resourceId`): `Promise`\<`void`\> - -#### Parameters - -• **resourceId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/ResourceActionApi.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L13) - ---- - -### stopWatching() - -> **stopWatching**(`resourceId`): `Promise`\<`void`\> - -#### Parameters - -• **resourceId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/ResourceActionApi.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L21) - ---- - -### watch() - -> **watch**(`resourceId`): `Promise`\<`void`\> - -#### Parameters - -• **resourceId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/ResourceActionApi.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L17) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/ResourceApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/ResourceApi.md deleted file mode 100644 index 4c46c03b..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/ResourceApi.md +++ /dev/null @@ -1,200 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ResourceApi - -# Class: ResourceApi - -附件资源相关 api - -## Constructors - -### new ResourceApi() - -> **new ResourceApi**(`ajax`): [`ResourceApi`](ResourceApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`ResourceApi`](ResourceApi.md) - -#### Defined in - -[api/ResourceApi.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L13) - -## Methods - -### create() - -> **create**(`param`): `Promise`\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\> - -Creates a new resource -TODO 目前大批量上传文件仍有问题 -Creating a new resource is special because you also need to upload the file. Unlike other API calls, this one must have the "multipart/form-data" Content-Type. The file data must be passed to the "data" form field, and the other properties to the "props" form field. An example of a valid call with cURL would be: -The "data" field is required, while the "props" one is not. If not specified, default values will be used. - -#### Parameters - -• **param**: `object` & `Partial`\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\> - -#### Returns - -`Promise`\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\> - -#### Defined in - -[api/ResourceApi.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L44) - ---- - -### fileById() - -> **fileById**(`id`): `Promise`\<`Blob`\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`Blob`\> - -#### Defined in - -[api/ResourceApi.ts:85](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L85) - ---- - -### fileByResourceId() - -> **fileByResourceId**(`id`): `Promise`\<`Buffer`\> - -Gets the actual file associated with this resource. - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`Buffer`\> - -#### Defined in - -[api/ResourceApi.ts:74](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L74) - ---- - -### get() - -#### get(id) - -> **get**(`id`): `Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\> - -##### Parameters - -• **id**: `string` - -##### Returns - -`Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\> - -##### Defined in - -[api/ResourceApi.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L25) - -#### get(id, fields) - -> **get**\<`K`\>(`id`, `fields`): `Promise`\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Type Parameters - -• **K** _extends_ keyof [`ResourceProperties`](../interfaces/ResourceProperties.md) = `"id"` \| `"title"` - -##### Parameters - -• **id**: `string` - -• **fields**: `K`[] - -##### Returns - -`Promise`\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\> - -##### Defined in - -[api/ResourceApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L26) - ---- - -### list() - -#### list(undefined) - -> **list**(): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\>\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\>\> - -##### Defined in - -[api/ResourceApi.ts:15](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L15) - -#### list(pageParam) - -> **list**\<`K`\>(`pageParam`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\>\>\> - -##### Type Parameters - -• **K** _extends_ keyof [`ResourceProperties`](../interfaces/ResourceProperties.md) - -##### Parameters - -• **pageParam**: [`PageParam`](../interfaces/PageParam.md)\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `K`\>\>\> - -##### Defined in - -[api/ResourceApi.ts:16](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L16) - ---- - -### remove() - -> **remove**(`id`): `Promise`\<`void`\> - -TODO 这个 api 存在 bug - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/ResourceApi.ts:66](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L66) - ---- - -### update() - -> **update**(`param`): `Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\> - -#### Parameters - -• **param**: `Required`\<`Pick`\<`Partial`\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\>, `"id"`\>\> & `Omit`\<`Partial`\<[`ResourceProperties`](../interfaces/ResourceProperties.md)\>, `"id"`\> & `object` - -#### Returns - -`Promise`\<[`ResourceGetRes`](../type-aliases/ResourceGetRes.md)\> - -#### Defined in - -[api/ResourceApi.ts:53](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceApi.ts#L53) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/SearchApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/SearchApi.md deleted file mode 100644 index c8e1ce8d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/SearchApi.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / SearchApi - -# Class: SearchApi - -## Constructors - -### new SearchApi() - -> **new SearchApi**(`ajax`): [`SearchApi`](SearchApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`SearchApi`](SearchApi.md) - -#### Defined in - -[api/SearchApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/SearchApi.ts#L10) - -## Methods - -### search() - -> **search**\<`K`\>(`param`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\>\> - -#### Type Parameters - -• **K** _extends_ keyof [`NoteProperties`](../interfaces/NoteProperties.md) - -#### Parameters - -• **param**: `object` & [`PageParam`](../interfaces/PageParam.md)\<[`NoteProperties`](../interfaces/NoteProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -#### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `K`\> & [`CommonType`](../interfaces/CommonType.md)\>\> - -#### Defined in - -[api/SearchApi.ts:30](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/SearchApi.ts#L30) diff --git a/packages/website/docs/en-US/dev/joplin-api/classes/TagApi.md b/packages/website/docs/en-US/dev/joplin-api/classes/TagApi.md deleted file mode 100644 index 81920c31..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/classes/TagApi.md +++ /dev/null @@ -1,189 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / TagApi - -# Class: TagApi - -## Constructors - -### new TagApi() - -> **new TagApi**(`ajax`): [`TagApi`](TagApi.md) - -#### Parameters - -• **ajax**: `Ajax` - -#### Returns - -[`TagApi`](TagApi.md) - -#### Defined in - -[api/TagApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L10) - -## Methods - -### addTagByNoteId() - -> **addTagByNoteId**(`tagId`, `noteId`): `Promise`\<`null` \| [`NoteTagRelated`](../type-aliases/NoteTagRelated.md)\> - -Post a note to this endpoint to add the tag to the note. The note data must at least contain an ID property (all other properties will be ignored). - -#### Parameters - -• **tagId**: `string` - -• **noteId**: `string` - -#### Returns - -`Promise`\<`null` \| [`NoteTagRelated`](../type-aliases/NoteTagRelated.md)\> - -#### Defined in - -[api/TagApi.ts:46](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L46) - ---- - -### create() - -> **create**(`param`): `Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Parameters - -• **param**: `Pick`\<[`BaseProperties`](../interfaces/BaseProperties.md), `"title"`\> - -#### Returns - -`Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Defined in - -[api/TagApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L24) - ---- - -### get() - -> **get**(`id`): `Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Defined in - -[api/TagApi.ts:20](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L20) - ---- - -### list() - -#### list(undefined) - -> **list**(): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`TagGetRes`](../type-aliases/TagGetRes.md)\>\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`TagGetRes`](../type-aliases/TagGetRes.md)\>\> - -##### Defined in - -[api/TagApi.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L12) - -#### list(pageParam) - -> **list**\<`K`\>(`pageParam`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`BaseProperties`](../interfaces/BaseProperties.md), `K`\>\>\> - -##### Type Parameters - -• **K** _extends_ keyof [`BaseProperties`](../interfaces/BaseProperties.md) - -##### Parameters - -• **pageParam**: [`PageParam`](../interfaces/PageParam.md)\<[`BaseProperties`](../interfaces/BaseProperties.md)\> & [`FieldsParam`](../interfaces/FieldsParam.md)\<`K`\> - -##### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<`Pick`\<[`BaseProperties`](../interfaces/BaseProperties.md), `K`\>\>\> - -##### Defined in - -[api/TagApi.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L13) - ---- - -### notesByTagId() - -> **notesByTagId**(`__namedParameters`): `Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)\>\> - -#### Parameters - -• **\_\_namedParameters**: `object` & [`PageParam`](../interfaces/PageParam.md)\<[`BaseProperties`](../interfaces/BaseProperties.md)\> - -#### Returns - -`Promise`\<[`PageRes`](../interfaces/PageRes.md)\<[`NoteGetRes`](../type-aliases/NoteGetRes.md)\>\> - -#### Defined in - -[api/TagApi.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L37) - ---- - -### remove() - -> **remove**(`id`): `Promise`\<[`BaseProperties`](../interfaces/BaseProperties.md)\> - -#### Parameters - -• **id**: `string` - -#### Returns - -`Promise`\<[`BaseProperties`](../interfaces/BaseProperties.md)\> - -#### Defined in - -[api/TagApi.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L33) - ---- - -### removeTagByNoteId() - -> **removeTagByNoteId**(`tagId`, `noteId`): `Promise`\<`void`\> - -#### Parameters - -• **tagId**: `string` - -• **noteId**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[api/TagApi.ts:52](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L52) - ---- - -### update() - -> **update**(`param`): `Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Parameters - -• **param**: `Pick`\<[`BaseProperties`](../interfaces/BaseProperties.md), `"id"` \| `"title"`\> - -#### Returns - -`Promise`\<[`TagGetRes`](../type-aliases/TagGetRes.md)\> - -#### Defined in - -[api/TagApi.ts:28](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/TagApi.ts#L28) diff --git a/packages/website/docs/en-US/dev/joplin-api/enumerations/NoteActionEnum.md b/packages/website/docs/en-US/dev/joplin-api/enumerations/NoteActionEnum.md deleted file mode 100644 index edfa9e2d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/enumerations/NoteActionEnum.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteActionEnum - -# Enumeration: NoteActionEnum - -## Enumeration Members - -### NoteIsWatched - -> **NoteIsWatched**: `"noteIsWatched"` - -#### Defined in - -[api/NoteActionApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L6) - ---- - -### OpenAndWatch - -> **OpenAndWatch**: `"openAndWatch"` - -#### Defined in - -[api/NoteActionApi.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L4) - ---- - -### StopWatching - -> **StopWatching**: `"stopWatching"` - -#### Defined in - -[api/NoteActionApi.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L5) diff --git a/packages/website/docs/en-US/dev/joplin-api/enumerations/ResourceActionEnum.md b/packages/website/docs/en-US/dev/joplin-api/enumerations/ResourceActionEnum.md deleted file mode 100644 index 62b45fd1..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/enumerations/ResourceActionEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ResourceActionEnum - -# Enumeration: ResourceActionEnum - -## Enumeration Members - -### NoteIsWatched - -> **NoteIsWatched**: `"isWatched"` - -#### Defined in - -[api/ResourceActionApi.ts:7](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L7) - ---- - -### OpenAndWatch - -> **OpenAndWatch**: `"openAndWatch"` - -#### Defined in - -[api/ResourceActionApi.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L4) - ---- - -### StopWatching - -> **StopWatching**: `"stopWatching"` - -#### Defined in - -[api/ResourceActionApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L6) - ---- - -### Watch - -> **Watch**: `"watch"` - -#### Defined in - -[api/ResourceActionApi.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/ResourceActionApi.ts#L5) diff --git a/packages/website/docs/en-US/dev/joplin-api/enumerations/TypeEnum.md b/packages/website/docs/en-US/dev/joplin-api/enumerations/TypeEnum.md deleted file mode 100644 index c862065f..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/enumerations/TypeEnum.md +++ /dev/null @@ -1,153 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / TypeEnum - -# Enumeration: TypeEnum - -## Enumeration Members - -### Alarm - -> **Alarm**: `8` - -#### Defined in - -[model/TypeEnum.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L9) - ---- - -### Folder - -> **Folder**: `2` - -#### Defined in - -[model/TypeEnum.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L3) - ---- - -### ItemChange - -> **ItemChange**: `10` - -#### Defined in - -[model/TypeEnum.ts:11](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L11) - ---- - -### MasterKey - -> **MasterKey**: `9` - -#### Defined in - -[model/TypeEnum.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L10) - ---- - -### Migration - -> **Migration**: `14` - -#### Defined in - -[model/TypeEnum.ts:15](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L15) - ---- - -### Note - -> **Note**: `1` - -#### Defined in - -[model/TypeEnum.ts:2](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L2) - ---- - -### NoteResource - -> **NoteResource**: `11` - -#### Defined in - -[model/TypeEnum.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L12) - ---- - -### NoteTag - -> **NoteTag**: `6` - -#### Defined in - -[model/TypeEnum.ts:7](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L7) - ---- - -### Resource - -> **Resource**: `4` - -#### Defined in - -[model/TypeEnum.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L5) - ---- - -### ResourceLocalState - -> **ResourceLocalState**: `12` - -#### Defined in - -[model/TypeEnum.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L13) - ---- - -### Revision - -> **Revision**: `13` - -#### Defined in - -[model/TypeEnum.ts:14](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L14) - ---- - -### Search - -> **Search**: `7` - -#### Defined in - -[model/TypeEnum.ts:8](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L8) - ---- - -### Setting - -> **Setting**: `3` - -#### Defined in - -[model/TypeEnum.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L4) - ---- - -### SmartFilter - -> **SmartFilter**: `15` - -#### Defined in - -[model/TypeEnum.ts:16](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L16) - ---- - -### Tag - -> **Tag**: `5` - -#### Defined in - -[model/TypeEnum.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TypeEnum.ts#L6) diff --git a/packages/website/docs/en-US/dev/joplin-api/functions/joplinDataApi.md b/packages/website/docs/en-US/dev/joplin-api/functions/joplinDataApi.md deleted file mode 100644 index 6c0dc04d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/functions/joplinDataApi.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / joplinDataApi - -# Function: joplinDataApi() - -> **joplinDataApi**(`options`): [`Api`](../interfaces/Api.md) - -## Parameters - -• **options**: [`ApiConfig`](../type-aliases/ApiConfig.md) - -## Returns - -[`Api`](../interfaces/Api.md) - -## Defined in - -[api/adapter.ts:139](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L139) diff --git a/packages/website/docs/en-US/dev/joplin-api/globals.md b/packages/website/docs/en-US/dev/joplin-api/globals.md deleted file mode 100644 index cfdc7b65..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/globals.md +++ /dev/null @@ -1,79 +0,0 @@ -[Documentation](../packages.md) / joplin-api - -# joplin-api - -## Enumerations - -- [NoteActionEnum](enumerations/NoteActionEnum.md) -- [ResourceActionEnum](enumerations/ResourceActionEnum.md) -- [TypeEnum](enumerations/TypeEnum.md) - -## Classes - -- [Config](classes/Config.md) -- [EventApi](classes/EventApi.md) -- [FolderApi](classes/FolderApi.md) -- [FolderExtApi](classes/FolderExtApi.md) -- [JoplinApi](classes/JoplinApi.md) -- [JoplinApiGenerator](classes/JoplinApiGenerator.md) -- [NoteActionApi](classes/NoteActionApi.md) -- [NoteApi](classes/NoteApi.md) -- [NoteExtApi](classes/NoteExtApi.md) -- [PageUtil](classes/PageUtil.md) -- [ResourceActionApi](classes/ResourceActionApi.md) -- [ResourceApi](classes/ResourceApi.md) -- [SearchApi](classes/SearchApi.md) -- [TagApi](classes/TagApi.md) - -## Interfaces - -- [Api](interfaces/Api.md) -- [BaseProperties](interfaces/BaseProperties.md) -- [CommonType](interfaces/CommonType.md) -- [EventProperties](interfaces/EventProperties.md) -- [FieldsParam](interfaces/FieldsParam.md) -- [FolderListRecursionGetTree](interfaces/FolderListRecursionGetTree.md) -- [FolderProperties](interfaces/FolderProperties.md) -- [NoteProperties](interfaces/NoteProperties.md) -- [PageParam](interfaces/PageParam.md) -- [PageRes](interfaces/PageRes.md) -- [ResourceProperties](interfaces/ResourceProperties.md) - -## Type Aliases - -- [ApiConfig](type-aliases/ApiConfig.md) -- [EventGetRes](type-aliases/EventGetRes.md) -- [EventListRes](type-aliases/EventListRes.md) -- [FolderCreateRes](type-aliases/FolderCreateRes.md) -- [FolderGetRes](type-aliases/FolderGetRes.md) -- [FolderListAllRes](type-aliases/FolderListAllRes.md) -- [FolderListRes](type-aliases/FolderListRes.md) -- [FolderUpdateRes](type-aliases/FolderUpdateRes.md) -- [NoteCreateRes](type-aliases/NoteCreateRes.md) -- [NoteGetRes](type-aliases/NoteGetRes.md) -- [NoteTagRelated](type-aliases/NoteTagRelated.md) -- [NoteUpdateRes](type-aliases/NoteUpdateRes.md) -- [ResourceGetRes](type-aliases/ResourceGetRes.md) -- [TagGetRes](type-aliases/TagGetRes.md) -- [TagProperties](type-aliases/TagProperties.md) - -## Variables - -- [actionApi](variables/actionApi.md) -- [ajax](variables/ajax.md) -- [config](variables/config.md) -- [eventApi](variables/eventApi.md) -- [folderApi](variables/folderApi.md) -- [folderExtApi](variables/folderExtApi.md) -- [joplinApi](variables/joplinApi.md) -- [noteActionApi](variables/noteActionApi.md) -- [noteApi](variables/noteApi.md) -- [noteExtApi](variables/noteExtApi.md) -- [resourceActionApi](variables/resourceActionApi.md) -- [resourceApi](variables/resourceApi.md) -- [searchApi](variables/searchApi.md) -- [tagApi](variables/tagApi.md) - -## Functions - -- [joplinDataApi](functions/joplinDataApi.md) diff --git a/packages/website/docs/en-US/dev/joplin-api/index.md b/packages/website/docs/en-US/dev/joplin-api/index.md deleted file mode 100644 index 6c8cb49b..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/index.md +++ /dev/null @@ -1,7 +0,0 @@ -[Documentation](../packages.md) / joplin-api - -# joplin api - -A JavaScript wrapper for the Joplin API written in TypeScript. It provides complete type definitions and covers all currently documented APIs. - -Official documentation: diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/Api.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/Api.md deleted file mode 100644 index b5c25121..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/Api.md +++ /dev/null @@ -1,113 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / Api - -# Interface: Api - -## Properties - -### event - -> **event**: [`EventApi`](../classes/EventApi.md) - -#### Defined in - -[api/adapter.ts:126](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L126) - ---- - -### folder - -> **folder**: [`FolderApi`](../classes/FolderApi.md) - -#### Defined in - -[api/adapter.ts:116](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L116) - ---- - -### folderExt - -> **folderExt**: [`FolderExtApi`](../classes/FolderExtApi.md) - -#### Defined in - -[api/adapter.ts:117](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L117) - ---- - -### joplin - -> **joplin**: [`JoplinApi`](../classes/JoplinApi.md) - -#### Defined in - -[api/adapter.ts:118](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L118) - ---- - -### note - -> **note**: [`NoteApi`](../classes/NoteApi.md) - -#### Defined in - -[api/adapter.ts:120](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L120) - ---- - -### noteAction - -> **noteAction**: [`NoteActionApi`](../classes/NoteActionApi.md) - -#### Defined in - -[api/adapter.ts:119](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L119) - ---- - -### noteExt - -> **noteExt**: [`NoteExtApi`](../classes/NoteExtApi.md) - -#### Defined in - -[api/adapter.ts:121](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L121) - ---- - -### resource - -> **resource**: [`ResourceApi`](../classes/ResourceApi.md) - -#### Defined in - -[api/adapter.ts:123](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L123) - ---- - -### resourceAction - -> **resourceAction**: [`ResourceActionApi`](../classes/ResourceActionApi.md) - -#### Defined in - -[api/adapter.ts:122](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L122) - ---- - -### search - -> **search**: [`SearchApi`](../classes/SearchApi.md) - -#### Defined in - -[api/adapter.ts:124](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L124) - ---- - -### tag - -> **tag**: [`TagApi`](../classes/TagApi.md) - -#### Defined in - -[api/adapter.ts:125](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L125) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/BaseProperties.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/BaseProperties.md deleted file mode 100644 index 8b1a1bd0..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/BaseProperties.md +++ /dev/null @@ -1,113 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / BaseProperties - -# Interface: BaseProperties - -## Extended by - -- [`FolderProperties`](FolderProperties.md) -- [`NoteProperties`](NoteProperties.md) -- [`ResourceProperties`](ResourceProperties.md) - -## Properties - -### created_time - -> **created_time**: `number` - -When the folder was created. - -#### Defined in - -[model/BaseProperties.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L9) - ---- - -### encryption_applied - -> **encryption_applied**: `number` - -#### Defined in - -[model/BaseProperties.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L33) - ---- - -### encryption_cipher_text - -> **encryption_cipher_text**: `string` - -text - -#### Defined in - -[model/BaseProperties.ts:29](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L29) - ---- - -### id - -> **id**: `string` - -text - -#### Defined in - -[model/BaseProperties.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L5) - ---- - -### is_shared - -> **is_shared**: `number` - -#### Defined in - -[model/BaseProperties.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L37) - ---- - -### title - -> **title**: `string` - -The tag title. - -#### Defined in - -[model/BaseProperties.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L25) - ---- - -### updated_time - -> **updated_time**: `number` - -When the folder was last updated. - -#### Defined in - -[model/BaseProperties.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L13) - ---- - -### user_created_time - -> **user_created_time**: `number` - -When the folder was created. It may differ from created_time as it can be manually set by the user. - -#### Defined in - -[model/BaseProperties.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L17) - ---- - -### user_updated_time - -> **user_updated_time**: `number` - -When the folder was last updated. It may differ from updated_time as it can be manually set by the user. - -#### Defined in - -[model/BaseProperties.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L21) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/CommonType.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/CommonType.md deleted file mode 100644 index 45b7a63f..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/CommonType.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / CommonType - -# Interface: CommonType - -## Properties - -### type\_ - -> **type\_**: [`TypeEnum`](../enumerations/TypeEnum.md) - -#### Defined in - -[model/CommonType.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/CommonType.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/EventProperties.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/EventProperties.md deleted file mode 100644 index 81bde0c8..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/EventProperties.md +++ /dev/null @@ -1,73 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / EventProperties - -# Interface: EventProperties - -## Properties - -### before_change_item - -> **before_change_item**: `string` - -#### Defined in - -[api/EventApi.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L12) - ---- - -### created_time - -> **created_time**: `number` - -#### Defined in - -[api/EventApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L10) - ---- - -### id - -> **id**: `number` - -#### Defined in - -[api/EventApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L6) - ---- - -### item_id - -> **item_id**: `string` - -#### Defined in - -[api/EventApi.ts:8](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L8) - ---- - -### item_type - -> **item_type**: `number` - -#### Defined in - -[api/EventApi.ts:7](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L7) - ---- - -### source - -> **source**: `number` - -#### Defined in - -[api/EventApi.ts:11](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L11) - ---- - -### type - -> **type**: `number` - -#### Defined in - -[api/EventApi.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L9) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/FieldsParam.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/FieldsParam.md deleted file mode 100644 index 8e096f27..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/FieldsParam.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FieldsParam - -# Interface: FieldsParam\ - -## Type Parameters - -• **K** - -## Properties - -### fields? - -> `optional` **fields**: `K`[] - -#### Defined in - -[model/FieldsParam.ts:2](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FieldsParam.ts#L2) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderListRecursionGetTree.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderListRecursionGetTree.md deleted file mode 100644 index 42dacdf1..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderListRecursionGetTree.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderListRecursionGetTree - -# Interface: FolderListRecursionGetTree - -## Properties - -### as_tree? - -> `optional` **as_tree**: `IntBool` - -#### Defined in - -[model/FolderListRecursionGetTree.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderListRecursionGetTree.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderProperties.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderProperties.md deleted file mode 100644 index 829c0b9d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/FolderProperties.md +++ /dev/null @@ -1,159 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderProperties - -# Interface: FolderProperties - -## Extends - -- [`BaseProperties`](BaseProperties.md) - -## Properties - -### created_time - -> **created_time**: `number` - -When the folder was created. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`created_time`](BaseProperties.md#created-time) - -#### Defined in - -[model/BaseProperties.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L9) - ---- - -### encryption_applied - -> **encryption_applied**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_applied`](BaseProperties.md#encryption-applied) - -#### Defined in - -[model/BaseProperties.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L33) - ---- - -### encryption_cipher_text - -> **encryption_cipher_text**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_cipher_text`](BaseProperties.md#encryption-cipher-text) - -#### Defined in - -[model/BaseProperties.ts:29](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L29) - ---- - -### id - -> **id**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`id`](BaseProperties.md#id) - -#### Defined in - -[model/BaseProperties.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L5) - ---- - -### is_shared - -> **is_shared**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`is_shared`](BaseProperties.md#is-shared) - -#### Defined in - -[model/BaseProperties.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L37) - ---- - -### parent_id - -> **parent_id**: `string` - -text - -#### Defined in - -[model/FolderProperties.ts:7](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderProperties.ts#L7) - ---- - -### title - -> **title**: `string` - -The tag title. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`title`](BaseProperties.md#title) - -#### Defined in - -[model/BaseProperties.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L25) - ---- - -### updated_time - -> **updated_time**: `number` - -When the folder was last updated. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`updated_time`](BaseProperties.md#updated-time) - -#### Defined in - -[model/BaseProperties.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L13) - ---- - -### user_created_time - -> **user_created_time**: `number` - -When the folder was created. It may differ from created_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_created_time`](BaseProperties.md#user-created-time) - -#### Defined in - -[model/BaseProperties.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L17) - ---- - -### user_updated_time - -> **user_updated_time**: `number` - -When the folder was last updated. It may differ from updated_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_updated_time`](BaseProperties.md#user-updated-time) - -#### Defined in - -[model/BaseProperties.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L21) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/NoteProperties.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/NoteProperties.md deleted file mode 100644 index 79f9e4b6..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/NoteProperties.md +++ /dev/null @@ -1,403 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteProperties - -# Interface: NoteProperties - -## Extends - -- [`BaseProperties`](BaseProperties.md) - -## Properties - -### altitude - -> **altitude**: `number` - -numeric - -#### Defined in - -[model/NoteProperties.ts:28](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L28) - ---- - -### application_data - -> **application_data**: `string` - -text - -#### Defined in - -[model/NoteProperties.ts:60](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L60) - ---- - -### author - -> **author**: `string` - -text - -#### Defined in - -[model/NoteProperties.ts:32](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L32) - ---- - -### base_url - -> **base_url**: `string` - -If body_html is provided and contains relative URLs, provide the base_url parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the '?'). For example if the original page was https://stackoverflow.com/search?q=%5Bjava%5D+test, the base URL is https://stackoverflow.com/search. - -#### Defined in - -[model/NoteProperties.ts:76](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L76) - ---- - -### body - -> **body**: `string` - -The note body, in Markdown. May also contain HTML. - -#### Defined in - -[model/NoteProperties.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L12) - ---- - -### body_html - -> **body_html**: `string` - -Note body, in HTML format - -#### Defined in - -[model/NoteProperties.ts:72](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L72) - ---- - -### created_time - -> **created_time**: `number` - -When the folder was created. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`created_time`](BaseProperties.md#created-time) - -#### Defined in - -[model/BaseProperties.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L9) - ---- - -### crop_rect - -> **crop_rect**: `object` - -If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format `{ x: x, y: y, width: width, height: height }` - -#### height - -> **height**: `number` - -#### width - -> **width**: `number` - -#### x - -> **x**: `number` - -#### y - -> **y**: `number` - -#### Defined in - -[model/NoteProperties.ts:84](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L84) - ---- - -### encryption_applied - -> **encryption_applied**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_applied`](BaseProperties.md#encryption-applied) - -#### Defined in - -[model/BaseProperties.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L33) - ---- - -### encryption_cipher_text - -> **encryption_cipher_text**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_cipher_text`](BaseProperties.md#encryption-cipher-text) - -#### Defined in - -[model/BaseProperties.ts:29](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L29) - ---- - -### id - -> **id**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`id`](BaseProperties.md#id) - -#### Defined in - -[model/BaseProperties.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L5) - ---- - -### image_data_url - -> **image_data_url**: `string` - -An image to attach to the note, in Data URL format. - -#### Defined in - -[model/NoteProperties.ts:80](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L80) - ---- - -### is_conflict - -> **is_conflict**: `number` - -Tells whether the note is a conflict or not. - -#### Defined in - -[model/NoteProperties.ts:16](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L16) - ---- - -### is_shared - -> **is_shared**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`is_shared`](BaseProperties.md#is-shared) - -#### Defined in - -[model/BaseProperties.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L37) - ---- - -### is_todo - -> **is_todo**: `IntBool` - -Tells whether this note is a to-do or not. - -#### Defined in - -[model/NoteProperties.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L40) - ---- - -### latitude - -> **latitude**: `number` - -numeric - -#### Defined in - -[model/NoteProperties.ts:20](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L20) - ---- - -### longitude - -> **longitude**: `number` - -numeric - -#### Defined in - -[model/NoteProperties.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L24) - ---- - -### markup_language - -> **markup_language**: `number` - -int - -#### Defined in - -[model/NoteProperties.ts:68](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L68) - ---- - -### order - -> **order**: `number` - -int - -#### Defined in - -[model/NoteProperties.ts:64](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L64) - ---- - -### parent_id - -> **parent_id**: `string` - -ID of the notebook that contains this note. Change this ID to move the note to a different notebook. - -#### Defined in - -[model/NoteProperties.ts:8](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L8) - ---- - -### source - -> **source**: `string` - -text - -#### Defined in - -[model/NoteProperties.ts:52](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L52) - ---- - -### source_application - -> **source_application**: `string` - -text - -#### Defined in - -[model/NoteProperties.ts:56](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L56) - ---- - -### source_url - -> **source_url**: `string` - -The full URL where the note comes from. - -#### Defined in - -[model/NoteProperties.ts:36](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L36) - ---- - -### title - -> **title**: `string` - -The tag title. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`title`](BaseProperties.md#title) - -#### Defined in - -[model/BaseProperties.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L25) - ---- - -### todo_completed - -> **todo_completed**: `IntBool` - -Tells whether to-do is completed or not. This is a timestamp in milliseconds. - -#### Defined in - -[model/NoteProperties.ts:48](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L48) - ---- - -### todo_due - -> **todo_due**: `IntBool` - -When the to-do is due. An alarm will be triggered on that date. - -#### Defined in - -[model/NoteProperties.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteProperties.ts#L44) - ---- - -### updated_time - -> **updated_time**: `number` - -When the folder was last updated. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`updated_time`](BaseProperties.md#updated-time) - -#### Defined in - -[model/BaseProperties.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L13) - ---- - -### user_created_time - -> **user_created_time**: `number` - -When the folder was created. It may differ from created_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_created_time`](BaseProperties.md#user-created-time) - -#### Defined in - -[model/BaseProperties.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L17) - ---- - -### user_updated_time - -> **user_updated_time**: `number` - -When the folder was last updated. It may differ from updated_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_updated_time`](BaseProperties.md#user-updated-time) - -#### Defined in - -[model/BaseProperties.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L21) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/PageParam.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/PageParam.md deleted file mode 100644 index 36e98101..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/PageParam.md +++ /dev/null @@ -1,47 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / PageParam - -# Interface: PageParam\ - -## Type Parameters - -• **T** - -## Properties - -### limit? - -> `optional` **limit**: `number` - -#### Defined in - -[model/PageData.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L3) - ---- - -### order_by? - -> `optional` **order_by**: keyof `T` - -#### Defined in - -[model/PageData.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L4) - ---- - -### order_dir? - -> `optional` **order_dir**: `"ASC"` \| `"DESC"` - -#### Defined in - -[model/PageData.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L5) - ---- - -### page? - -> `optional` **page**: `number` - -#### Defined in - -[model/PageData.ts:2](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L2) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/PageRes.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/PageRes.md deleted file mode 100644 index 10c6c45b..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/PageRes.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / PageRes - -# Interface: PageRes\ - -分页返回数据 - -## Link - -https://joplinapp.org/api/references/rest_api/#pagination - -## Type Parameters - -• **T** - -## Properties - -### has_more - -> **has_more**: `boolean` - -#### Defined in - -[model/PageData.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L13) - ---- - -### items - -> **items**: `T`[] - -#### Defined in - -[model/PageData.ts:14](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/PageData.ts#L14) diff --git a/packages/website/docs/en-US/dev/joplin-api/interfaces/ResourceProperties.md b/packages/website/docs/en-US/dev/joplin-api/interfaces/ResourceProperties.md deleted file mode 100644 index 0975447f..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/interfaces/ResourceProperties.md +++ /dev/null @@ -1,197 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ResourceProperties - -# Interface: ResourceProperties - -## Extends - -- [`BaseProperties`](BaseProperties.md) - -## Properties - -### created_time - -> **created_time**: `number` - -When the folder was created. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`created_time`](BaseProperties.md#created-time) - -#### Defined in - -[model/BaseProperties.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L9) - ---- - -### encryption_applied - -> **encryption_applied**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_applied`](BaseProperties.md#encryption-applied) - -#### Defined in - -[model/BaseProperties.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L33) - ---- - -### encryption_blob_encrypted - -> **encryption_blob_encrypted**: `number` - -#### Defined in - -[model/ResourceProperties.ts:19](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceProperties.ts#L19) - ---- - -### encryption_cipher_text - -> **encryption_cipher_text**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`encryption_cipher_text`](BaseProperties.md#encryption-cipher-text) - -#### Defined in - -[model/BaseProperties.ts:29](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L29) - ---- - -### file_extension - -> **file_extension**: `string` - -#### Defined in - -[model/ResourceProperties.ts:15](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceProperties.ts#L15) - ---- - -### filename - -> **filename**: `string` - -#### Defined in - -[model/ResourceProperties.ts:11](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceProperties.ts#L11) - ---- - -### id - -> **id**: `string` - -text - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`id`](BaseProperties.md#id) - -#### Defined in - -[model/BaseProperties.ts:5](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L5) - ---- - -### is_shared - -> **is_shared**: `number` - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`is_shared`](BaseProperties.md#is-shared) - -#### Defined in - -[model/BaseProperties.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L37) - ---- - -### mime - -> **mime**: `string` - -#### Defined in - -[model/ResourceProperties.ts:7](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceProperties.ts#L7) - ---- - -### size - -> **size**: `number` - -#### Defined in - -[model/ResourceProperties.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceProperties.ts#L23) - ---- - -### title - -> **title**: `string` - -The tag title. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`title`](BaseProperties.md#title) - -#### Defined in - -[model/BaseProperties.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L25) - ---- - -### updated_time - -> **updated_time**: `number` - -When the folder was last updated. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`updated_time`](BaseProperties.md#updated-time) - -#### Defined in - -[model/BaseProperties.ts:13](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L13) - ---- - -### user_created_time - -> **user_created_time**: `number` - -When the folder was created. It may differ from created_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_created_time`](BaseProperties.md#user-created-time) - -#### Defined in - -[model/BaseProperties.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L17) - ---- - -### user_updated_time - -> **user_updated_time**: `number` - -When the folder was last updated. It may differ from updated_time as it can be manually set by the user. - -#### Inherited from - -[`BaseProperties`](BaseProperties.md).[`user_updated_time`](BaseProperties.md#user-updated-time) - -#### Defined in - -[model/BaseProperties.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/BaseProperties.ts#L21) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/ApiConfig.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/ApiConfig.md deleted file mode 100644 index 666296a2..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/ApiConfig.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ApiConfig - -# Type Alias: ApiConfig - -> **ApiConfig**: `object` \| `object` - -## Defined in - -[api/adapter.ts:129](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/adapter.ts#L129) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventGetRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventGetRes.md deleted file mode 100644 index 01ec7922..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventGetRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / EventGetRes - -# Type Alias: EventGetRes - -> **EventGetRes**: `Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `"id"` \| `"item_type"` \| `"item_id"` \| `"type"` \| `"created_time"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[api/EventApi.ts:15](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L15) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventListRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventListRes.md deleted file mode 100644 index 3869ecf6..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/EventListRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / EventListRes - -# Type Alias: EventListRes - -> **EventListRes**: `Pick`\<[`EventProperties`](../interfaces/EventProperties.md), `"id"` \| `"item_type"` \| `"item_id"` \| `"type"` \| `"created_time"`\> - -## Defined in - -[api/EventApi.ts:17](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L17) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderCreateRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderCreateRes.md deleted file mode 100644 index a4ae36ca..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderCreateRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderCreateRes - -# Type Alias: FolderCreateRes - -> **FolderCreateRes**: `Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `"id"` \| `"title"` \| `"parent_id"` \| `"updated_time"` \| `"created_time"` \| `"user_updated_time"` \| `"user_created_time"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/FolderCreateRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderCreateRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderGetRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderGetRes.md deleted file mode 100644 index bb8a2ee6..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderGetRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderGetRes - -# Type Alias: FolderGetRes - -> **FolderGetRes**: [`FolderProperties`](../interfaces/FolderProperties.md) & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/FolderGetRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderGetRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListAllRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListAllRes.md deleted file mode 100644 index 1f9eade2..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListAllRes.md +++ /dev/null @@ -1,19 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderListAllRes - -# Type Alias: FolderListAllRes - -> **FolderListAllRes**: `Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `"id"` \| `"parent_id"` \| `"title"`\> & `object` & [`CommonType`](../interfaces/CommonType.md) - -## Type declaration - -### children? - -> `optional` **children**: [`FolderListAllRes`](FolderListAllRes.md)[] - -### note_count - -> **note_count**: `number` - -## Defined in - -[model/FolderListAllRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderListAllRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListRes.md deleted file mode 100644 index ef12839f..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderListRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderListRes - -# Type Alias: FolderListRes - -> **FolderListRes**: `Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `"id"` \| `"parent_id"` \| `"title"`\> - -## Defined in - -[model/FolderListRes.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderListRes.ts#L3) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderUpdateRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderUpdateRes.md deleted file mode 100644 index 280f85b9..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/FolderUpdateRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / FolderUpdateRes - -# Type Alias: FolderUpdateRes - -> **FolderUpdateRes**: `Pick`\<[`FolderProperties`](../interfaces/FolderProperties.md), `"id"` \| `"title"` \| `"created_time"` \| `"updated_time"` \| `"user_created_time"` \| `"user_updated_time"` \| `"encryption_cipher_text"` \| `"encryption_applied"` \| `"parent_id"` \| `"is_shared"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/FolderUpdateRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/FolderUpdateRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteCreateRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteCreateRes.md deleted file mode 100644 index 2cdecb2e..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteCreateRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteCreateRes - -# Type Alias: NoteCreateRes - -> **NoteCreateRes**: `Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `"id"` \| `"title"` \| `"body"` \| `"parent_id"` \| `"markup_language"` \| `"updated_time"` \| `"created_time"` \| `"source"` \| `"source_application"` \| `"user_updated_time"` \| `"user_created_time"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/NoteCreateRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteCreateRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteGetRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteGetRes.md deleted file mode 100644 index 07c25eca..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteGetRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteGetRes - -# Type Alias: NoteGetRes - -> **NoteGetRes**: `Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `"id"` \| `"title"` \| `"parent_id"`\> - -## Defined in - -[model/NoteGetRes.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteGetRes.ts#L3) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteTagRelated.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteTagRelated.md deleted file mode 100644 index 531fd7df..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteTagRelated.md +++ /dev/null @@ -1,19 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteTagRelated - -# Type Alias: NoteTagRelated - -> **NoteTagRelated**: [`CommonType`](../interfaces/CommonType.md) & `Pick`\<[`BaseProperties`](../interfaces/BaseProperties.md), `"id"` \| `"updated_time"` \| `"created_time"` \| `"user_updated_time"` \| `"user_created_time"`\> & `object` - -## Type declaration - -### note_id - -> **note_id**: `string` - -### tag_id - -> **tag_id**: `string` - -## Defined in - -[model/NoteTagRelated.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteTagRelated.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteUpdateRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteUpdateRes.md deleted file mode 100644 index 1b4312ea..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/NoteUpdateRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / NoteUpdateRes - -# Type Alias: NoteUpdateRes - -> **NoteUpdateRes**: `Pick`\<[`NoteProperties`](../interfaces/NoteProperties.md), `"id"` \| `"parent_id"` \| `"title"` \| `"body"` \| `"created_time"` \| `"updated_time"` \| `"is_conflict"` \| `"latitude"` \| `"longitude"` \| `"altitude"` \| `"author"` \| `"source_url"` \| `"is_todo"` \| `"todo_due"` \| `"todo_completed"` \| `"source"` \| `"source_application"` \| `"application_data"` \| `"order"` \| `"user_created_time"` \| `"user_updated_time"` \| `"encryption_cipher_text"` \| `"encryption_applied"` \| `"markup_language"` \| `"is_shared"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/NoteUpdateRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/NoteUpdateRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/ResourceGetRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/ResourceGetRes.md deleted file mode 100644 index 1baf136f..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/ResourceGetRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ResourceGetRes - -# Type Alias: ResourceGetRes - -> **ResourceGetRes**: `Pick`\<[`ResourceProperties`](../interfaces/ResourceProperties.md), `"id"` \| `"title"`\> & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/ResourceGetRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/ResourceGetRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagGetRes.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagGetRes.md deleted file mode 100644 index df781bb8..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagGetRes.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / TagGetRes - -# Type Alias: TagGetRes - -> **TagGetRes**: [`TagProperties`](TagProperties.md) & [`CommonType`](../interfaces/CommonType.md) - -## Defined in - -[model/TagGetRes.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TagGetRes.ts#L4) diff --git a/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagProperties.md b/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagProperties.md deleted file mode 100644 index 5540054c..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/type-aliases/TagProperties.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / TagProperties - -# Type Alias: TagProperties - -> **TagProperties**: [`BaseProperties`](../interfaces/BaseProperties.md) - -## Defined in - -[model/TagProperties.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/model/TagProperties.ts#L3) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/actionApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/actionApi.md deleted file mode 100644 index 59cf6e01..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/actionApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / actionApi - -# Variable: actionApi - -> **actionApi**: [`NoteActionApi`](../classes/NoteActionApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:78](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L78) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/ajax.md b/packages/website/docs/en-US/dev/joplin-api/variables/ajax.md deleted file mode 100644 index a9753ad3..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/ajax.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / ajax - -# Variable: ajax - -> **ajax**: `Ajax` - -## Defined in - -[api/JoplinApiGenerator.ts:56](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L56) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/config.md b/packages/website/docs/en-US/dev/joplin-api/variables/config.md deleted file mode 100644 index 9ec791ef..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/config.md +++ /dev/null @@ -1,11 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / config - -# Variable: config - -> `const` **config**: `Pick`\<[`JoplinApiGenerator`](../classes/JoplinApiGenerator.md), `"token"` \| `"baseUrl"`\> = `joplinApiGenerator` - -兼容之前的类型 - -## Defined in - -[api/JoplinApiGenerator.ts:73](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L73) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/eventApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/eventApi.md deleted file mode 100644 index 164b1a13..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/eventApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / eventApi - -# Variable: eventApi - -> **eventApi**: [`EventApi`](../classes/EventApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:67](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L67) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/folderApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/folderApi.md deleted file mode 100644 index 212c1341..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/folderApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / folderApi - -# Variable: folderApi - -> **folderApi**: [`FolderApi`](../classes/FolderApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:57](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L57) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/folderExtApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/folderExtApi.md deleted file mode 100644 index 803a89ef..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/folderExtApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / folderExtApi - -# Variable: folderExtApi - -> **folderExtApi**: [`FolderExtApi`](../classes/FolderExtApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:58](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L58) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/joplinApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/joplinApi.md deleted file mode 100644 index 1323d926..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/joplinApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / joplinApi - -# Variable: joplinApi - -> **joplinApi**: [`JoplinApi`](../classes/JoplinApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:59](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L59) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/noteActionApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/noteActionApi.md deleted file mode 100644 index 4cac24ae..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/noteActionApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / noteActionApi - -# Variable: noteActionApi - -> **noteActionApi**: [`NoteActionApi`](../classes/NoteActionApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:60](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L60) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/noteApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/noteApi.md deleted file mode 100644 index 7b2684e3..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/noteApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / noteApi - -# Variable: noteApi - -> **noteApi**: [`NoteApi`](../classes/NoteApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:61](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L61) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/noteExtApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/noteExtApi.md deleted file mode 100644 index d4f1935d..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/noteExtApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / noteExtApi - -# Variable: noteExtApi - -> **noteExtApi**: [`NoteExtApi`](../classes/NoteExtApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:62](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L62) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/resourceActionApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/resourceActionApi.md deleted file mode 100644 index f0e64b24..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/resourceActionApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / resourceActionApi - -# Variable: resourceActionApi - -> **resourceActionApi**: [`ResourceActionApi`](../classes/ResourceActionApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:63](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L63) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/resourceApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/resourceApi.md deleted file mode 100644 index 9e4c1a43..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/resourceApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / resourceApi - -# Variable: resourceApi - -> **resourceApi**: [`ResourceApi`](../classes/ResourceApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:64](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L64) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/searchApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/searchApi.md deleted file mode 100644 index 47126e63..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/searchApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / searchApi - -# Variable: searchApi - -> **searchApi**: [`SearchApi`](../classes/SearchApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:65](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L65) diff --git a/packages/website/docs/en-US/dev/joplin-api/variables/tagApi.md b/packages/website/docs/en-US/dev/joplin-api/variables/tagApi.md deleted file mode 100644 index 65ea93cd..00000000 --- a/packages/website/docs/en-US/dev/joplin-api/variables/tagApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-api](../index.md) / tagApi - -# Variable: tagApi - -> **tagApi**: [`TagApi`](../classes/TagApi.md) - -## Defined in - -[api/JoplinApiGenerator.ts:66](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L66) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/AppType.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/AppType.md deleted file mode 100644 index f0ff7265..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/AppType.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / AppType - -# Enumeration: AppType - -## Enumeration Members - -### Cli - -> **Cli**: `"cli"` - -#### Defined in - -[types.ts:398](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L398) - ---- - -### Desktop - -> **Desktop**: `"desktop"` - -#### Defined in - -[types.ts:396](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L396) - ---- - -### Mobile - -> **Mobile**: `"mobile"` - -#### Defined in - -[types.ts:397](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L397) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ContentScriptType.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ContentScriptType.md deleted file mode 100644 index 6e8d601c..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ContentScriptType.md +++ /dev/null @@ -1,191 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ContentScriptType - -# Enumeration: ContentScriptType - -## Enumeration Members - -### CodeMirrorPlugin - -> **CodeMirrorPlugin**: `"codeMirrorPlugin"` - -Registers a new CodeMirror plugin, which should follow the template -below. - -```javascript -module.exports = { - default: function (context) { - return { - plugin: function (CodeMirror) { - // ... - }, - codeMirrorResources: [], - codeMirrorOptions: { - // ... - }, - assets: { - // ... - }, - } - }, -} -``` - -- The `context` argument is currently unused but could be used later on - to provide access to your own plugin so that the content script and - plugin can communicate. - -- The `plugin` key is your CodeMirror plugin. This is where you can - register new commands with CodeMirror or interact with the CodeMirror - instance as needed. - -- The `codeMirrorResources` key is an array of CodeMirror resources that - will be loaded and attached to the CodeMirror module. These are made up - of addons, keymaps, and modes. For example, for a plugin that want's to - enable clojure highlighting in code blocks. `codeMirrorResources` would - be set to `['mode/clojure/clojure']`. - -- The `codeMirrorOptions` key contains all the - [CodeMirror](https://codemirror.net/doc/manual.html#config) options - that will be set or changed by this plugin. New options can alse be - declared via - [`CodeMirror.defineOption`](https://codemirror.net/doc/manual.html#defineOption), - and then have their value set here. For example, a plugin that enables - line numbers would set `codeMirrorOptions` to `{'lineNumbers': true}`. - -- Using the **optional** `assets` key you may specify **only** CSS assets - that should be loaded in the rendered HTML document. Check for example - the Joplin [Mermaid - plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) - to see how the data should be structured. - -One of the `plugin`, `codeMirrorResources`, or `codeMirrorOptions` keys -must be provided for the plugin to be valid. Having multiple or all -provided is also okay. - -See also the [demo -plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) -for an example of all these keys being used in one plugin. - -## Posting messages from the content script to your plugin - -In order to post messages to the plugin, you can use the postMessage -function passed to the [context](../interfaces/ContentScriptContext.md). - -```javascript -const response = await context.postMessage('messageFromCodeMirrorContentScript') -``` - -When you post a message, the plugin can send back a `response` thus -allowing two-way communication: - -```javascript -await joplin.contentScripts.onMessage(contentScriptId, (message) => { - // Process message - return response // Can be any object, string or number -}) -``` - -See JoplinContentScripts.onMessage for more details, as well as -the [postMessage -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). - -#### Defined in - -[types.ts:749](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L749) - ---- - -### MarkdownItPlugin - -> **MarkdownItPlugin**: `"markdownItPlugin"` - -Registers a new Markdown-It plugin, which should follow the template -below. - -```javascript -module.exports = { - default: function (context) { - return { - plugin: function (markdownIt, pluginOptions) { - // ... - }, - assets: { - // ... - }, - } - }, -} -``` - -See [the -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) -for a simple Markdown-it plugin example. - -## Exported members - -- The `context` argument is currently unused but could be used later on - to provide access to your own plugin so that the content script and - plugin can communicate. - -- The **required** `plugin` key is the actual Markdown-It plugin - check - the [official doc](https://github.com/markdown-it/markdown-it) for more - information. - -- Using the **optional** `assets` key you may specify assets such as JS - or CSS that should be loaded in the rendered HTML document. Check for - example the Joplin [Mermaid - plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) - to see how the data should be structured. - -## Getting the settings from the renderer - -You can access your plugin settings from the renderer by calling -`pluginOptions.settingValue("your-setting-key')`. - -## Posting messages from the content script to your plugin - -The application provides the following function to allow executing -commands from the rendered HTML code: - -```javascript -const response = await webviewApi.postMessage(contentScriptId, message) -``` - -- `contentScriptId` is the ID you've defined when you registered the - content script. You can retrieve it from the - [context](../interfaces/ContentScriptContext.md). -- `message` can be any basic JavaScript type (number, string, plain - object), but it cannot be a function or class instance. - -When you post a message, the plugin can send back a `response` thus -allowing two-way communication: - -```javascript -await joplin.contentScripts.onMessage(contentScriptId, (message) => { - // Process message - return response // Can be any object, string or number -}) -``` - -See JoplinContentScripts.onMessage for more details, as well as -the [postMessage -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). - -## Registering an existing Markdown-it plugin - -To include a regular Markdown-It plugin, that doesn't make use of any -Joplin-specific features, you would simply create a file such as this: - -```javascript -module.exports = { - default: function(context) { - return { - plugin: require('markdown-it-toc-done-right'); - } - } -} -``` - -#### Defined in - -[types.ts:664](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L664) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/FileSystemItem.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/FileSystemItem.md deleted file mode 100644 index 07520257..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/FileSystemItem.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / FileSystemItem - -# Enumeration: FileSystemItem - -## Enumeration Members - -### Directory - -> **Directory**: `"directory"` - -#### Defined in - -[types.ts:67](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L67) - ---- - -### File - -> **File**: `"file"` - -#### Defined in - -[types.ts:66](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L66) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ImportModuleOutputFormat.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ImportModuleOutputFormat.md deleted file mode 100644 index eea7fa88..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ImportModuleOutputFormat.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ImportModuleOutputFormat - -# Enumeration: ImportModuleOutputFormat - -## Enumeration Members - -### Html - -> **Html**: `"html"` - -#### Defined in - -[types.ts:72](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L72) - ---- - -### Markdown - -> **Markdown**: `"md"` - -#### Defined in - -[types.ts:71](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L71) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/MenuItemLocation.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/MenuItemLocation.md deleted file mode 100644 index ebe3705a..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/MenuItemLocation.md +++ /dev/null @@ -1,132 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / MenuItemLocation - -# Enumeration: MenuItemLocation - -## Enumeration Members - -### ~~Context~~ - -> **Context**: `"context"` - -#### Deprecated - -Do not use - same as NoteListContextMenu - -#### Defined in - -[types.ts:253](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L253) - ---- - -### Edit - -> **Edit**: `"edit"` - -#### Defined in - -[types.ts:244](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L244) - ---- - -### EditorContextMenu - -> **EditorContextMenu**: `"editorContextMenu"` - -#### Defined in - -[types.ts:265](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L265) - ---- - -### File - -> **File**: `"file"` - -#### Defined in - -[types.ts:243](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L243) - ---- - -### FolderContextMenu - -> **FolderContextMenu**: `"folderContextMenu"` - -When a command is called from a folder context menu, the -command will receive the following arguments: - -- `folderId:string`: ID of the folder that was right-clicked on - -#### Defined in - -[types.ts:273](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L273) - ---- - -### Help - -> **Help**: `"help"` - -#### Defined in - -[types.ts:248](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L248) - ---- - -### Note - -> **Note**: `"note"` - -#### Defined in - -[types.ts:246](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L246) - ---- - -### NoteListContextMenu - -> **NoteListContextMenu**: `"noteListContextMenu"` - -When a command is called from the note list context menu, the -command will receive the following arguments: - -- `noteIds:string[]`: IDs of the notes that were right-clicked on. - -#### Defined in - -[types.ts:263](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L263) - ---- - -### TagContextMenu - -> **TagContextMenu**: `"tagContextMenu"` - -When a command is called from a tag context menu, the -command will receive the following arguments: - -- `tagId:string`: ID of the tag that was right-clicked on - -#### Defined in - -[types.ts:281](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L281) - ---- - -### Tools - -> **Tools**: `"tools"` - -#### Defined in - -[types.ts:247](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L247) - ---- - -### View - -> **View**: `"view"` - -#### Defined in - -[types.ts:245](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L245) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ModelType.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ModelType.md deleted file mode 100644 index 054996ba..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ModelType.md +++ /dev/null @@ -1,163 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ModelType - -# Enumeration: ModelType - -## Enumeration Members - -### Alarm - -> **Alarm**: `8` - -#### Defined in - -[types.ts:215](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L215) - ---- - -### Command - -> **Command**: `16` - -#### Defined in - -[types.ts:223](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L223) - ---- - -### Folder - -> **Folder**: `2` - -#### Defined in - -[types.ts:209](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L209) - ---- - -### ItemChange - -> **ItemChange**: `10` - -#### Defined in - -[types.ts:217](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L217) - ---- - -### MasterKey - -> **MasterKey**: `9` - -#### Defined in - -[types.ts:216](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L216) - ---- - -### Migration - -> **Migration**: `14` - -#### Defined in - -[types.ts:221](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L221) - ---- - -### Note - -> **Note**: `1` - -#### Defined in - -[types.ts:208](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L208) - ---- - -### NoteResource - -> **NoteResource**: `11` - -#### Defined in - -[types.ts:218](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L218) - ---- - -### NoteTag - -> **NoteTag**: `6` - -#### Defined in - -[types.ts:213](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L213) - ---- - -### Resource - -> **Resource**: `4` - -#### Defined in - -[types.ts:211](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L211) - ---- - -### ResourceLocalState - -> **ResourceLocalState**: `12` - -#### Defined in - -[types.ts:219](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L219) - ---- - -### Revision - -> **Revision**: `13` - -#### Defined in - -[types.ts:220](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L220) - ---- - -### Search - -> **Search**: `7` - -#### Defined in - -[types.ts:214](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L214) - ---- - -### Setting - -> **Setting**: `3` - -#### Defined in - -[types.ts:210](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L210) - ---- - -### SmartFilter - -> **SmartFilter**: `15` - -#### Defined in - -[types.ts:222](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L222) - ---- - -### Tag - -> **Tag**: `5` - -#### Defined in - -[types.ts:212](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L212) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemSubType.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemSubType.md deleted file mode 100644 index 09ad752a..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemSubType.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / SettingItemSubType - -# Enumeration: SettingItemSubType - -## Enumeration Members - -### DirectoryPath - -> **DirectoryPath**: `"directory_path"` - -#### Defined in - -[types.ts:392](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L392) - ---- - -### FilePath - -> **FilePath**: `"file_path"` - -#### Defined in - -[types.ts:391](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L391) - ---- - -### FilePathAndArgs - -> **FilePathAndArgs**: `"file_path_and_args"` - -#### Defined in - -[types.ts:390](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L390) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemType.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemType.md deleted file mode 100644 index fb6bbe89..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingItemType.md +++ /dev/null @@ -1,63 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / SettingItemType - -# Enumeration: SettingItemType - -## Enumeration Members - -### Array - -> **Array**: `4` - -#### Defined in - -[types.ts:384](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L384) - ---- - -### Bool - -> **Bool**: `3` - -#### Defined in - -[types.ts:383](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L383) - ---- - -### Button - -> **Button**: `6` - -#### Defined in - -[types.ts:386](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L386) - ---- - -### Int - -> **Int**: `1` - -#### Defined in - -[types.ts:381](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L381) - ---- - -### Object - -> **Object**: `5` - -#### Defined in - -[types.ts:385](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L385) - ---- - -### String - -> **String**: `2` - -#### Defined in - -[types.ts:382](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L382) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingStorage.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingStorage.md deleted file mode 100644 index d23fecc6..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/SettingStorage.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / SettingStorage - -# Enumeration: SettingStorage - -## Enumeration Members - -### Database - -> **Database**: `1` - -#### Defined in - -[types.ts:402](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L402) - ---- - -### File - -> **File**: `2` - -#### Defined in - -[types.ts:403](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L403) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ToolbarButtonLocation.md b/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ToolbarButtonLocation.md deleted file mode 100644 index a0372716..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/enumerations/ToolbarButtonLocation.md +++ /dev/null @@ -1,27 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ToolbarButtonLocation - -# Enumeration: ToolbarButtonLocation - -## Enumeration Members - -### EditorToolbar - -> **EditorToolbar**: `"editorToolbar"` - -This toolbar is right above the text editor. It applies to the note body only. - -#### Defined in - -[types.ts:349](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L349) - ---- - -### NoteToolbar - -> **NoteToolbar**: `"noteToolbar"` - -This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata. - -#### Defined in - -[types.ts:344](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L344) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/functions/isContextMenuItemLocation.md b/packages/website/docs/en-US/dev/joplin-plugin-api/functions/isContextMenuItemLocation.md deleted file mode 100644 index f378db59..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/functions/isContextMenuItemLocation.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / isContextMenuItemLocation - -# Function: isContextMenuItemLocation() - -> **isContextMenuItemLocation**(`location`): `boolean` - -## Parameters - -• **location**: [`MenuItemLocation`](../enumerations/MenuItemLocation.md) - -## Returns - -`boolean` - -## Defined in - -[types.ts:284](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L284) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/globals.md b/packages/website/docs/en-US/dev/joplin-plugin-api/globals.md deleted file mode 100644 index a61eb49f..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/globals.md +++ /dev/null @@ -1,58 +0,0 @@ -[Documentation](../packages.md) / joplin-plugin-api - -# joplin-plugin-api - -## Enumerations - -- [AppType](enumerations/AppType.md) -- [ContentScriptType](enumerations/ContentScriptType.md) -- [FileSystemItem](enumerations/FileSystemItem.md) -- [ImportModuleOutputFormat](enumerations/ImportModuleOutputFormat.md) -- [MenuItemLocation](enumerations/MenuItemLocation.md) -- [ModelType](enumerations/ModelType.md) -- [SettingItemSubType](enumerations/SettingItemSubType.md) -- [SettingItemType](enumerations/SettingItemType.md) -- [SettingStorage](enumerations/SettingStorage.md) -- [ToolbarButtonLocation](enumerations/ToolbarButtonLocation.md) - -## Interfaces - -- [ButtonSpec](interfaces/ButtonSpec.md) -- [CodeMirrorContentScriptModule](interfaces/CodeMirrorContentScriptModule.md) -- [CodeMirrorControl](interfaces/CodeMirrorControl.md) -- [Command](interfaces/Command.md) -- [ContentScriptContext](interfaces/ContentScriptContext.md) -- [ContentScriptModule](interfaces/ContentScriptModule.md) -- [ContentScriptModuleLoadedEvent](interfaces/ContentScriptModuleLoadedEvent.md) -- [CreateMenuItemOptions](interfaces/CreateMenuItemOptions.md) -- [DialogResult](interfaces/DialogResult.md) -- [Disposable](interfaces/Disposable.md) -- [EditorCommand](interfaces/EditorCommand.md) -- [ExportContext](interfaces/ExportContext.md) -- [ExportModule](interfaces/ExportModule.md) -- [ExportOptions](interfaces/ExportOptions.md) -- [ImportContext](interfaces/ImportContext.md) -- [ImportModule](interfaces/ImportModule.md) -- [MarkdownItContentScriptModule](interfaces/MarkdownItContentScriptModule.md) -- [MenuItem](interfaces/MenuItem.md) -- [Rectangle](interfaces/Rectangle.md) -- [Script](interfaces/Script.md) -- [SettingItem](interfaces/SettingItem.md) -- [SettingSection](interfaces/SettingSection.md) -- [Size](interfaces/Size.md) -- [VersionInfo](interfaces/VersionInfo.md) - -## Type Aliases - -- [ButtonId](type-aliases/ButtonId.md) -- [Path](type-aliases/Path.md) -- [PostMessageHandler](type-aliases/PostMessageHandler.md) -- [ViewHandle](type-aliases/ViewHandle.md) - -## Variables - -- [default](variables/default.md) - -## Functions - -- [isContextMenuItemLocation](functions/isContextMenuItemLocation.md) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/index.md b/packages/website/docs/en-US/dev/joplin-plugin-api/index.md deleted file mode 100644 index 38ebe6b8..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/index.md +++ /dev/null @@ -1,7 +0,0 @@ -[Documentation](../packages.md) / joplin-plugin-api - -# joplin-plugin-api - -This package provides the API for Joplin plugins. It's a TypeScript package that can be used to create plugins for Joplin. - -Official documentation: diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ButtonSpec.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ButtonSpec.md deleted file mode 100644 index 02094397..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ButtonSpec.md +++ /dev/null @@ -1,37 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ButtonSpec - -# Interface: ButtonSpec - -## Properties - -### id - -> **id**: `string` - -#### Defined in - -[types.ts:333](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L333) - ---- - -### title? - -> `optional` **title**: `string` - -#### Defined in - -[types.ts:334](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L334) - -## Methods - -### onClick()? - -> `optional` **onClick**(): `void` - -#### Returns - -`void` - -#### Defined in - -[types.ts:335](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L335) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorContentScriptModule.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorContentScriptModule.md deleted file mode 100644 index bc5743b4..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorContentScriptModule.md +++ /dev/null @@ -1,65 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / CodeMirrorContentScriptModule - -# Interface: CodeMirrorContentScriptModule - -## Extends - -- `Omit`\<[`ContentScriptModule`](ContentScriptModule.md), `"plugin"`\> - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Inherited from - -`Omit.assets` - -#### Defined in - -[types.ts:531](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L531) - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Inherited from - -`Omit.onLoaded` - -#### Defined in - -[types.ts:529](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L529) - ---- - -### plugin() - -> **plugin**: (`codeMirrorControl`) => `void` - -#### Parameters - -• **codeMirrorControl**: [`CodeMirrorControl`](CodeMirrorControl.md) - -#### Returns - -`void` - -#### Defined in - -[types.ts:572](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L572) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorControl.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorControl.md deleted file mode 100644 index 2f1c2f51..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorControl.md +++ /dev/null @@ -1,149 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / CodeMirrorControl - -# Interface: CodeMirrorControl - -## Properties - -### cm6 - -> **cm6**: `any` - -#### Defined in - -[types.ts:543](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L543) - ---- - -### editor - -> **editor**: `any` - -Points to a CodeMirror 6 EditorView instance. - -#### Defined in - -[types.ts:542](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L542) - ---- - -### joplinExtensions - -> **joplinExtensions**: `object` - -#### enableLanguageDataAutocomplete - -> **enableLanguageDataAutocomplete**: `object` - -Creates an extension that enables or disables [`languageData`-based autocompletion](https://codemirror.net/docs/ref/#autocomplete.autocompletion^config.override). - -#### enableLanguageDataAutocomplete.of() - -> **enableLanguageDataAutocomplete.of**: (`enabled`) => `any` - -##### Parameters - -• **enabled**: `boolean` - -##### Returns - -`any` - -#### completionSource() - -Returns a [CodeMirror 6 extension](https://codemirror.net/docs/ref/#state.Extension) that -registers the given [CompletionSource](https://codemirror.net/docs/ref/#autocomplete.CompletionSource). - -Use this extension rather than the built-in CodeMirror [`autocompletion`](https://codemirror.net/docs/ref/#autocomplete.autocompletion) -if you don't want to use [languageData-based autocompletion](https://codemirror.net/docs/ref/#autocomplete.autocompletion^config.override). - -Using `autocompletion({ override: [ ... ]})` causes errors when done by multiple plugins. - -##### Parameters - -• **completionSource**: `any` - -##### Returns - -`any` - -#### Defined in - -[types.ts:552](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L552) - -## Methods - -### addExtension() - -> **addExtension**(`extension`): `void` - -`extension` should be a [CodeMirror 6 extension](https://codemirror.net/docs/ref/#state.Extension). - -#### Parameters - -• **extension**: `any` - -#### Returns - -`void` - -#### Defined in - -[types.ts:546](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L546) - ---- - -### execCommand() - -> **execCommand**(`name`, ...`args`): `any` - -#### Parameters - -• **name**: `string` - -• ...**args**: `any`[] - -#### Returns - -`any` - -#### Defined in - -[types.ts:549](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L549) - ---- - -### registerCommand() - -> **registerCommand**(`name`, `callback`): `void` - -#### Parameters - -• **name**: `string` - -• **callback**: `EditorCommandCallback` - -#### Returns - -`void` - -#### Defined in - -[types.ts:550](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L550) - ---- - -### supportsCommand() - -> **supportsCommand**(`name`): `boolean` - -#### Parameters - -• **name**: `string` - -#### Returns - -`boolean` - -#### Defined in - -[types.ts:548](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L548) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Command.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Command.md deleted file mode 100644 index f91bda55..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Command.md +++ /dev/null @@ -1,98 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Command - -# Interface: Command - -## Properties - -### enabledCondition? - -> `optional` **enabledCondition**: `string` - -Defines whether the command should be enabled or disabled, which in turns -affects the enabled state of any associated button or menu item. - -The condition should be expressed as a "when-clause" (as in Visual Studio -Code). It's a simple boolean expression that evaluates to `true` or -`false`. It supports the following operators: - -| Operator | Symbol | Example | -| ---------- | ------ | -------------------------------------- | -| Equality | == | "editorType == markdown" | -| Inequality | != | "currentScreen != config" | -| Or | \|\| | "noteIsTodo \|\| noteTodoCompleted" | -| And | && | "oneNoteSelected && !inConflictFolder" | - -Joplin, unlike VSCode, also supports parentheses, which allows creating -more complex expressions such as `cond1 || (cond2 && cond3)`. Only one -level of parentheses is possible (nested ones aren't supported). - -Currently the supported context variables aren't documented, but you can -find the list below: - -- [Global When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/lib/services/commands/stateToWhenClauseContext.ts) -- [Desktop app When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/app-desktop/services/commands/stateToWhenClauseContext.ts) - -Note: Commands are enabled by default unless you use this property. - -#### Defined in - -[types.ts:58](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L58) - ---- - -### iconName? - -> `optional` **iconName**: `string` - -Icon to be used on toolbar buttons for example - -#### Defined in - -[types.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L24) - ---- - -### label? - -> `optional` **label**: `string` - -Label to be displayed on menu items or keyboard shortcut editor for example. -If it is missing, it's assumed it's a private command, to be called programmatically only. -In that case the command will not appear in the shortcut editor or command panel, and logically -should not be used as a menu item. - -#### Defined in - -[types.ts:19](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L19) - ---- - -### name - -> **name**: `string` - -Name of command - must be globally unique - -#### Defined in - -[types.ts:11](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L11) - -## Methods - -### execute() - -> **execute**(...`args`): `Promise`\<`any`\> - -Code to be ran when the command is executed. It may return a result. - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`Promise`\<`any`\> - -#### Defined in - -[types.ts:29](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L29) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptContext.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptContext.md deleted file mode 100644 index 72e04130..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptContext.md +++ /dev/null @@ -1,41 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ContentScriptContext - -# Interface: ContentScriptContext - -When a content script is initialised, it receives a `context` object. - -## Properties - -### contentScriptId - -> **contentScriptId**: `string` - -The content script ID, which may be necessary to post messages - -#### Defined in - -[types.ts:516](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L516) - ---- - -### pluginId - -> **pluginId**: `string` - -The plugin ID that registered this content script - -#### Defined in - -[types.ts:511](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L511) - ---- - -### postMessage - -> **postMessage**: [`PostMessageHandler`](../type-aliases/PostMessageHandler.md) - -Can be used by CodeMirror content scripts to post a message to the plugin - -#### Defined in - -[types.ts:521](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L521) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModule.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModule.md deleted file mode 100644 index b01b9cb3..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModule.md +++ /dev/null @@ -1,49 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ContentScriptModule - -# Interface: ContentScriptModule - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Defined in - -[types.ts:531](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L531) - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Defined in - -[types.ts:529](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L529) - ---- - -### plugin() - -> **plugin**: () => `any` - -#### Returns - -`any` - -#### Defined in - -[types.ts:530](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L530) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModuleLoadedEvent.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModuleLoadedEvent.md deleted file mode 100644 index 213fab1a..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModuleLoadedEvent.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ContentScriptModuleLoadedEvent - -# Interface: ContentScriptModuleLoadedEvent - -## Properties - -### userData? - -> `optional` **userData**: `any` - -#### Defined in - -[types.ts:525](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L525) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CreateMenuItemOptions.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CreateMenuItemOptions.md deleted file mode 100644 index 31ab3dc8..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/CreateMenuItemOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / CreateMenuItemOptions - -# Interface: CreateMenuItemOptions - -## Properties - -### accelerator - -> **accelerator**: `string` - -#### Defined in - -[types.ts:239](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L239) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/DialogResult.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/DialogResult.md deleted file mode 100644 index f4b2e51c..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/DialogResult.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / DialogResult - -# Interface: DialogResult - -## Properties - -### formData? - -> `optional` **formData**: `any` - -#### Defined in - -[types.ts:361](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L361) - ---- - -### id - -> **id**: `string` - -#### Defined in - -[types.ts:360](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L360) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Disposable.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Disposable.md deleted file mode 100644 index 0c152d64..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Disposable.md +++ /dev/null @@ -1,3 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Disposable - -# Interface: Disposable diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/EditorCommand.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/EditorCommand.md deleted file mode 100644 index b55b36f2..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/EditorCommand.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / EditorCommand - -# Interface: EditorCommand - -## Properties - -### name - -> **name**: `string` - -#### Defined in - -[types.ts:355](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L355) - ---- - -### value? - -> `optional` **value**: `any` - -#### Defined in - -[types.ts:356](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L356) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportContext.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportContext.md deleted file mode 100644 index 7844a1b0..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportContext.md +++ /dev/null @@ -1,35 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ExportContext - -# Interface: ExportContext - -## Properties - -### destPath - -> **destPath**: `string` - -#### Defined in - -[types.ts:180](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L180) - ---- - -### options - -> **options**: [`ExportOptions`](ExportOptions.md) - -#### Defined in - -[types.ts:181](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L181) - ---- - -### userData? - -> `optional` **userData**: `any` - -You can attach your own custom data using this property - it will then be passed to each event handler, allowing you to keep state from one event to the next. - -#### Defined in - -[types.ts:186](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L186) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportModule.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportModule.md deleted file mode 100644 index dbfbb037..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportModule.md +++ /dev/null @@ -1,159 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ExportModule - -# Interface: ExportModule - -Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/json_export) for an example. - -In general, all the event handlers you'll need to implement take a `context` object as a first argument. This object will contain the export or import path as well as various optional properties, such as which notes or notebooks need to be exported. - -To get a better sense of what it will contain it can be useful to print it using `console.info(context)`. - -## Properties - -### description - -> **description**: `string` - -The description that will appear in the UI, for example in the menu item. - -#### Defined in - -[types.ts:91](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L91) - ---- - -### fileExtensions? - -> `optional` **fileExtensions**: `string`[] - -The extensions of the files exported by your module. For example, it is `["htm", "html"]` for the HTML module, and just `["jex"]` for the JEX module. - -#### Defined in - -[types.ts:108](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L108) - ---- - -### format - -> **format**: `string` - -The format to be exported, eg "enex", "jex", "json", etc. - -#### Defined in - -[types.ts:86](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L86) - ---- - -### isNoteArchive - -> **isNoteArchive**: `boolean` - -Only applies to single file exporters or importers -It tells whether the format can package multiple notes into one file. -For example JEX or ENEX can, but HTML cannot. - -#### Defined in - -[types.ts:103](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L103) - ---- - -### target - -> **target**: [`FileSystemItem`](../enumerations/FileSystemItem.md) - -Whether the module will export a single file or multiple files in a directory. It affects the open dialog that will be presented to the user when using your exporter. - -#### Defined in - -[types.ts:96](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L96) - -## Methods - -### onClose() - -> **onClose**(`context`): `Promise`\<`void`\> - -Called when the export process is done. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:128](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L128) - ---- - -### onInit() - -> **onInit**(`context`): `Promise`\<`void`\> - -Called when the export process starts. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:113](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L113) - ---- - -### onProcessItem() - -> **onProcessItem**(`context`, `itemType`, `item`): `Promise`\<`void`\> - -Called when an item needs to be processed. An "item" can be any Joplin object, such as a note, a folder, a notebook, etc. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -• **itemType**: `number` - -• **item**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:118](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L118) - ---- - -### onProcessResource() - -> **onProcessResource**(`context`, `resource`, `filePath`): `Promise`\<`void`\> - -Called when a resource file needs to be exported. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -• **resource**: `any` - -• **filePath**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:123](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L123) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportOptions.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportOptions.md deleted file mode 100644 index 8e511340..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ExportOptions.md +++ /dev/null @@ -1,53 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ExportOptions - -# Interface: ExportOptions - -## Properties - -### format? - -> `optional` **format**: `string` - -#### Defined in - -[types.ts:171](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L171) - ---- - -### path? - -> `optional` **path**: `string` - -#### Defined in - -[types.ts:172](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L172) - ---- - -### sourceFolderIds? - -> `optional` **sourceFolderIds**: `string`[] - -#### Defined in - -[types.ts:173](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L173) - ---- - -### sourceNoteIds? - -> `optional` **sourceNoteIds**: `string`[] - -#### Defined in - -[types.ts:174](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L174) - ---- - -### target? - -> `optional` **target**: [`FileSystemItem`](../enumerations/FileSystemItem.md) - -#### Defined in - -[types.ts:176](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L176) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportContext.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportContext.md deleted file mode 100644 index 59b5a6b8..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportContext.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ImportContext - -# Interface: ImportContext - -## Properties - -### options - -> **options**: `any` - -#### Defined in - -[types.ts:191](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L191) - ---- - -### sourcePath - -> **sourcePath**: `string` - -#### Defined in - -[types.ts:190](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L190) - ---- - -### warnings - -> **warnings**: `string`[] - -#### Defined in - -[types.ts:192](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L192) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportModule.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportModule.md deleted file mode 100644 index 674ac946..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/ImportModule.md +++ /dev/null @@ -1,97 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ImportModule - -# Interface: ImportModule - -## Properties - -### description - -> **description**: `string` - -The description that will appear in the UI, for example in the menu item. - -#### Defined in - -[types.ts:140](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L140) - ---- - -### fileExtensions? - -> `optional` **fileExtensions**: `string`[] - -Tells the file extensions of the exported files. - -#### Defined in - -[types.ts:157](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L157) - ---- - -### format - -> **format**: `string` - -The format to be exported, eg "enex", "jex", "json", etc. - -#### Defined in - -[types.ts:135](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L135) - ---- - -### isNoteArchive - -> **isNoteArchive**: `boolean` - -Only applies to single file exporters or importers -It tells whether the format can package multiple notes into one file. -For example JEX or ENEX can, but HTML cannot. - -#### Defined in - -[types.ts:147](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L147) - ---- - -### outputFormat? - -> `optional` **outputFormat**: [`ImportModuleOutputFormat`](../enumerations/ImportModuleOutputFormat.md) - -Tells the type of notes that will be generated, either HTML or Markdown (default). - -#### Defined in - -[types.ts:162](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L162) - ---- - -### sources - -> **sources**: [`FileSystemItem`](../enumerations/FileSystemItem.md)[] - -The type of sources that are supported by the module. Tells whether the module can import files or directories or both. - -#### Defined in - -[types.ts:152](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L152) - -## Methods - -### onExec() - -> **onExec**(`context`): `Promise`\<`void`\> - -Called when the import process starts. There is only one event handler within which you should import the complete data. - -#### Parameters - -• **context**: [`ImportContext`](ImportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:167](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L167) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MarkdownItContentScriptModule.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MarkdownItContentScriptModule.md deleted file mode 100644 index 14e2ba63..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MarkdownItContentScriptModule.md +++ /dev/null @@ -1,67 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / MarkdownItContentScriptModule - -# Interface: MarkdownItContentScriptModule - -## Extends - -- `Omit`\<[`ContentScriptModule`](ContentScriptModule.md), `"plugin"`\> - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Inherited from - -`Omit.assets` - -#### Defined in - -[types.ts:531](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L531) - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Inherited from - -`Omit.onLoaded` - -#### Defined in - -[types.ts:529](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L529) - ---- - -### plugin() - -> **plugin**: (`markdownIt`, `options`) => `any` - -#### Parameters - -• **markdownIt**: `any` - -• **options**: `any` - -#### Returns - -`any` - -#### Defined in - -[types.ts:535](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L535) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MenuItem.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MenuItem.md deleted file mode 100644 index fa1a7190..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/MenuItem.md +++ /dev/null @@ -1,77 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / MenuItem - -# Interface: MenuItem - -## Properties - -### accelerator? - -> `optional` **accelerator**: `string` - -Accelerator associated with the menu item - -#### Defined in - -[types.ts:315](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L315) - ---- - -### commandArgs? - -> `optional` **commandArgs**: `any`[] - -Arguments that should be passed to the command. They will be as rest -parameters. - -#### Defined in - -[types.ts:305](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L305) - ---- - -### commandName? - -> `optional` **commandName**: `string` - -Command that should be associated with the menu item. All menu item should -have a command associated with them unless they are a sub-menu. - -#### Defined in - -[types.ts:299](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L299) - ---- - -### label? - -> `optional` **label**: `string` - -Menu item label. If not specified, the command label will be used instead. - -#### Defined in - -[types.ts:325](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L325) - ---- - -### submenu? - -> `optional` **submenu**: [`MenuItem`](MenuItem.md)[] - -Menu items that should appear below this menu item. Allows creating a menu tree. - -#### Defined in - -[types.ts:320](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L320) - ---- - -### type? - -> `optional` **type**: `"normal"` \| `"separator"` \| `"submenu"` \| `"checkbox"` \| `"radio"` - -Set to "separator" to create a divider line - -#### Defined in - -[types.ts:310](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L310) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Rectangle.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Rectangle.md deleted file mode 100644 index 14a3db91..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Rectangle.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Rectangle - -# Interface: Rectangle - -## Properties - -### height? - -> `optional` **height**: `number` - -#### Defined in - -[types.ts:373](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L373) - ---- - -### width? - -> `optional` **width**: `number` - -#### Defined in - -[types.ts:372](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L372) - ---- - -### x? - -> `optional` **x**: `number` - -#### Defined in - -[types.ts:370](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L370) - ---- - -### y? - -> `optional` **y**: `number` - -#### Defined in - -[types.ts:371](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L371) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Script.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Script.md deleted file mode 100644 index 95e11110..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Script.md +++ /dev/null @@ -1,21 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Script - -# Interface: Script - -## Methods - -### onStart()? - -> `optional` **onStart**(`event`): `Promise`\<`void`\> - -#### Parameters - -• **event**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[types.ts:200](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L200) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingItem.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingItem.md deleted file mode 100644 index 9bdd22b2..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingItem.md +++ /dev/null @@ -1,193 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / SettingItem - -# Interface: SettingItem - -## Properties - -### advanced? - -> `optional` **advanced**: `boolean` - -An advanced setting will be moved under the "Advanced" button in the -config screen. - -#### Defined in - -[types.ts:462](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L462) - ---- - -### appTypes? - -> `optional` **appTypes**: [`AppType`](../enumerations/AppType.md)[] - -Reserved property. Not used at the moment. - -#### Defined in - -[types.ts:450](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L450) - ---- - -### description? - -> `optional` **description**: `string` - -#### Defined in - -[types.ts:419](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L419) - ---- - -### isEnum? - -> `optional` **isEnum**: `boolean` - -To create a setting with multiple options, set this property to `true`. -That setting will render as a dropdown list in the configuration screen. - -#### Defined in - -[types.ts:439](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L439) - ---- - -### label - -> **label**: `string` - -#### Defined in - -[types.ts:418](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L418) - ---- - -### maximum? - -> `optional` **maximum**: `number` - -#### Defined in - -[types.ts:469](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L469) - ---- - -### minimum? - -> `optional` **minimum**: `number` - -Set the min, max and step values if you want to restrict an int setting -to a particular range. - -#### Defined in - -[types.ts:468](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L468) - ---- - -### options? - -> `optional` **options**: `Record`\<`any`, `any`\> - -This property is required when `isEnum` is `true`. In which case, it -should contain a map of value => label. - -#### Defined in - -[types.ts:445](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L445) - ---- - -### public - -> **public**: `boolean` - -A public setting will appear in the Configuration screen and will be -modifiable by the user. A private setting however will not appear there, -and can only be changed programmatically. You may use this to store some -values that you do not want to directly expose. - -#### Defined in - -[types.ts:427](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L427) - ---- - -### section? - -> `optional` **section**: `string` - -You would usually set this to a section you would have created -specifically for the plugin. - -#### Defined in - -[types.ts:433](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L433) - ---- - -### secure? - -> `optional` **secure**: `boolean` - -Set this to `true` to store secure data, such as passwords. Any such -setting will be stored in the system keychain if one is available. - -#### Defined in - -[types.ts:456](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L456) - ---- - -### step? - -> `optional` **step**: `number` - -#### Defined in - -[types.ts:470](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L470) - ---- - -### storage? - -> `optional` **storage**: [`SettingStorage`](../enumerations/SettingStorage.md) - -Either store the setting in the database or in settings.json. Defaults to database. - -#### Defined in - -[types.ts:475](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L475) - ---- - -### subType? - -> `optional` **subType**: [`SettingItemSubType`](../enumerations/SettingItemSubType.md) - -Currently only used to display a file or directory selector. Always set -`type` to `SettingItemType.String` when using this property. - -#### Defined in - -[types.ts:416](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L416) - ---- - -### type - -> **type**: [`SettingItemType`](../enumerations/SettingItemType.md) - -#### Defined in - -[types.ts:410](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L410) - ---- - -### value - -> **value**: `any` - -#### Defined in - -[types.ts:409](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L409) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingSection.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingSection.md deleted file mode 100644 index 7d7a1ed9..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/SettingSection.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / SettingSection - -# Interface: SettingSection - -## Properties - -### description? - -> `optional` **description**: `string` - -#### Defined in - -[types.ts:481](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L481) - ---- - -### iconName? - -> `optional` **iconName**: `string` - -#### Defined in - -[types.ts:480](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L480) - ---- - -### label - -> **label**: `string` - -#### Defined in - -[types.ts:479](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L479) - ---- - -### name? - -> `optional` **name**: `string` - -#### Defined in - -[types.ts:482](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L482) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Size.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Size.md deleted file mode 100644 index 30179d65..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/Size.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Size - -# Interface: Size - -## Properties - -### height? - -> `optional` **height**: `number` - -#### Defined in - -[types.ts:366](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L366) - ---- - -### width? - -> `optional` **width**: `number` - -#### Defined in - -[types.ts:365](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L365) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/VersionInfo.md b/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/VersionInfo.md deleted file mode 100644 index 72baf1d8..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/interfaces/VersionInfo.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / VersionInfo - -# Interface: VersionInfo - -## Properties - -### platform - -> **platform**: `"desktop"` \| `"mobile"` - -#### Defined in - -[types.ts:231](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L231) - ---- - -### profileVersion - -> **profileVersion**: `number` - -#### Defined in - -[types.ts:228](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L228) - ---- - -### syncVersion - -> **syncVersion**: `number` - -#### Defined in - -[types.ts:229](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L229) - ---- - -### version - -> **version**: `string` - -#### Defined in - -[types.ts:227](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L227) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ButtonId.md b/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ButtonId.md deleted file mode 100644 index 85fc3b6b..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ButtonId.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ButtonId - -# Type Alias: ButtonId - -> **ButtonId**: `string` - -## Defined in - -[types.ts:338](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L338) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/Path.md b/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/Path.md deleted file mode 100644 index 144c5ac9..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/Path.md +++ /dev/null @@ -1,15 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / Path - -# Type Alias: Path - -> **Path**: `string`[] - -An array of at least one element and at most three elements. - -- **[0]**: Resource name (eg. "notes", "folders", "tags", etc.) -- **[1]**: (Optional) Resource ID. -- **[2]**: (Optional) Resource link. - -## Defined in - -[types.ts:496](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L496) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/PostMessageHandler.md b/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/PostMessageHandler.md deleted file mode 100644 index 61c9fbe8..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/PostMessageHandler.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / PostMessageHandler - -# Type Alias: PostMessageHandler() - -> **PostMessageHandler**: (`message`) => `Promise`\<`any`\> - -## Parameters - -• **message**: `any` - -## Returns - -`Promise`\<`any`\> - -## Defined in - -[types.ts:502](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L502) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ViewHandle.md b/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ViewHandle.md deleted file mode 100644 index 28800c2c..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/type-aliases/ViewHandle.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / ViewHandle - -# Type Alias: ViewHandle - -> **ViewHandle**: `string` - -## Defined in - -[types.ts:352](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/types.ts#L352) diff --git a/packages/website/docs/en-US/dev/joplin-plugin-api/variables/default.md b/packages/website/docs/en-US/dev/joplin-plugin-api/variables/default.md deleted file mode 100644 index 1ef57713..00000000 --- a/packages/website/docs/en-US/dev/joplin-plugin-api/variables/default.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [joplin-plugin-api](../index.md) / default - -# Variable: default - -> `const` **default**: `Joplin` - -## Defined in - -[index.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-plugin-api/src/index.ts#L3) diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/AppType.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/AppType.md deleted file mode 100644 index de2f1c36..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/AppType.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / AppType - -# Enumeration: AppType - -## Enumeration Members - -### Cli - -> **Cli**: `"cli"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:303 - ---- - -### Desktop - -> **Desktop**: `"desktop"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:301 - ---- - -### Mobile - -> **Mobile**: `"mobile"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:302 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ContentScriptType.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ContentScriptType.md deleted file mode 100644 index 9a22ccab..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ContentScriptType.md +++ /dev/null @@ -1,191 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ContentScriptType - -# Enumeration: ContentScriptType - -## Enumeration Members - -### CodeMirrorPlugin - -> **CodeMirrorPlugin**: `"codeMirrorPlugin"` - -Registers a new CodeMirror plugin, which should follow the template -below. - -```javascript -module.exports = { - default: function (context) { - return { - plugin: function (CodeMirror) { - // ... - }, - codeMirrorResources: [], - codeMirrorOptions: { - // ... - }, - assets: { - // ... - }, - } - }, -} -``` - -- The `context` argument is currently unused but could be used later on - to provide access to your own plugin so that the content script and - plugin can communicate. - -- The `plugin` key is your CodeMirror plugin. This is where you can - register new commands with CodeMirror or interact with the CodeMirror - instance as needed. - -- The `codeMirrorResources` key is an array of CodeMirror resources that - will be loaded and attached to the CodeMirror module. These are made up - of addons, keymaps, and modes. For example, for a plugin that want's to - enable clojure highlighting in code blocks. `codeMirrorResources` would - be set to `['mode/clojure/clojure']`. - -- The `codeMirrorOptions` key contains all the - [CodeMirror](https://codemirror.net/doc/manual.html#config) options - that will be set or changed by this plugin. New options can alse be - declared via - [`CodeMirror.defineOption`](https://codemirror.net/doc/manual.html#defineOption), - and then have their value set here. For example, a plugin that enables - line numbers would set `codeMirrorOptions` to `{'lineNumbers': true}`. - -- Using the **optional** `assets` key you may specify **only** CSS assets - that should be loaded in the rendered HTML document. Check for example - the Joplin [Mermaid - plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) - to see how the data should be structured. - -One of the `plugin`, `codeMirrorResources`, or `codeMirrorOptions` keys -must be provided for the plugin to be valid. Having multiple or all -provided is also okay. - -See also the [demo -plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) -for an example of all these keys being used in one plugin. - -## Posting messages from the content script to your plugin - -In order to post messages to the plugin, you can use the postMessage -function passed to the [context](../interfaces/ContentScriptContext.md). - -```javascript -const response = await context.postMessage('messageFromCodeMirrorContentScript') -``` - -When you post a message, the plugin can send back a `response` thus -allowing two-way communication: - -```javascript -await joplin.contentScripts.onMessage(contentScriptId, (message) => { - // Process message - return response // Can be any object, string or number -}) -``` - -See JoplinContentScripts.onMessage for more details, as well as -the [postMessage -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:615 - ---- - -### MarkdownItPlugin - -> **MarkdownItPlugin**: `"markdownItPlugin"` - -Registers a new Markdown-It plugin, which should follow the template -below. - -```javascript -module.exports = { - default: function (context) { - return { - plugin: function (markdownIt, pluginOptions) { - // ... - }, - assets: { - // ... - }, - } - }, -} -``` - -See [the -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) -for a simple Markdown-it plugin example. - -## Exported members - -- The `context` argument is currently unused but could be used later on - to provide access to your own plugin so that the content script and - plugin can communicate. - -- The **required** `plugin` key is the actual Markdown-It plugin - check - the [official doc](https://github.com/markdown-it/markdown-it) for more - information. - -- Using the **optional** `assets` key you may specify assets such as JS - or CSS that should be loaded in the rendered HTML document. Check for - example the Joplin [Mermaid - plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) - to see how the data should be structured. - -## Getting the settings from the renderer - -You can access your plugin settings from the renderer by calling -`pluginOptions.settingValue("your-setting-key')`. - -## Posting messages from the content script to your plugin - -The application provides the following function to allow executing -commands from the rendered HTML code: - -```javascript -const response = await webviewApi.postMessage(contentScriptId, message) -``` - -- `contentScriptId` is the ID you've defined when you registered the - content script. You can retrieve it from the - [context](../interfaces/ContentScriptContext.md). -- `message` can be any basic JavaScript type (number, string, plain - object), but it cannot be a function or class instance. - -When you post a message, the plugin can send back a `response` thus -allowing two-way communication: - -```javascript -await joplin.contentScripts.onMessage(contentScriptId, (message) => { - // Process message - return response // Can be any object, string or number -}) -``` - -See JoplinContentScripts.onMessage for more details, as well as -the [postMessage -demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). - -## Registering an existing Markdown-it plugin - -To include a regular Markdown-It plugin, that doesn't make use of any -Joplin-specific features, you would simply create a file such as this: - -```javascript -module.exports = { - default: function(context) { - return { - plugin: require('markdown-it-toc-done-right'); - } - } -} -``` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:531 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/FileSystemItem.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/FileSystemItem.md deleted file mode 100644 index a92d4207..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/FileSystemItem.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / FileSystemItem - -# Enumeration: FileSystemItem - -## Enumeration Members - -### Directory - -> **Directory**: `"directory"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:52 - ---- - -### File - -> **File**: `"file"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:51 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ImportModuleOutputFormat.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ImportModuleOutputFormat.md deleted file mode 100644 index 18a4f963..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ImportModuleOutputFormat.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ImportModuleOutputFormat - -# Enumeration: ImportModuleOutputFormat - -## Enumeration Members - -### Html - -> **Html**: `"html"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:56 - ---- - -### Markdown - -> **Markdown**: `"md"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:55 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/MenuItemLocation.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/MenuItemLocation.md deleted file mode 100644 index 1eea235a..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/MenuItemLocation.md +++ /dev/null @@ -1,132 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / MenuItemLocation - -# Enumeration: MenuItemLocation - -## Enumeration Members - -### ~~Context~~ - -> **Context**: `"context"` - -#### Deprecated - -Do not use - same as NoteListContextMenu - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:199 - ---- - -### Edit - -> **Edit**: `"edit"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:191 - ---- - -### EditorContextMenu - -> **EditorContextMenu**: `"editorContextMenu"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:207 - ---- - -### File - -> **File**: `"file"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:190 - ---- - -### FolderContextMenu - -> **FolderContextMenu**: `"folderContextMenu"` - -When a command is called from a folder context menu, the -command will receive the following arguments: - -- `folderId:string`: ID of the folder that was right-clicked on - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:214 - ---- - -### Help - -> **Help**: `"help"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:195 - ---- - -### Note - -> **Note**: `"note"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:193 - ---- - -### NoteListContextMenu - -> **NoteListContextMenu**: `"noteListContextMenu"` - -When a command is called from the note list context menu, the -command will receive the following arguments: - -- `noteIds:string[]`: IDs of the notes that were right-clicked on. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:206 - ---- - -### TagContextMenu - -> **TagContextMenu**: `"tagContextMenu"` - -When a command is called from a tag context menu, the -command will receive the following arguments: - -- `tagId:string`: ID of the tag that was right-clicked on - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:221 - ---- - -### Tools - -> **Tools**: `"tools"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:194 - ---- - -### View - -> **View**: `"view"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:192 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ModelType.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ModelType.md deleted file mode 100644 index d97135ac..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ModelType.md +++ /dev/null @@ -1,163 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ModelType - -# Enumeration: ModelType - -## Enumeration Members - -### Alarm - -> **Alarm**: `8` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:170 - ---- - -### Command - -> **Command**: `16` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:178 - ---- - -### Folder - -> **Folder**: `2` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:164 - ---- - -### ItemChange - -> **ItemChange**: `10` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:172 - ---- - -### MasterKey - -> **MasterKey**: `9` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:171 - ---- - -### Migration - -> **Migration**: `14` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:176 - ---- - -### Note - -> **Note**: `1` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:163 - ---- - -### NoteResource - -> **NoteResource**: `11` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:173 - ---- - -### NoteTag - -> **NoteTag**: `6` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:168 - ---- - -### Resource - -> **Resource**: `4` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:166 - ---- - -### ResourceLocalState - -> **ResourceLocalState**: `12` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:174 - ---- - -### Revision - -> **Revision**: `13` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:175 - ---- - -### Search - -> **Search**: `7` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:169 - ---- - -### Setting - -> **Setting**: `3` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:165 - ---- - -### SmartFilter - -> **SmartFilter**: `15` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:177 - ---- - -### Tag - -> **Tag**: `5` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:167 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemSubType.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemSubType.md deleted file mode 100644 index 08adf596..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemSubType.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / SettingItemSubType - -# Enumeration: SettingItemSubType - -## Enumeration Members - -### DirectoryPath - -> **DirectoryPath**: `"directory_path"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:298 - ---- - -### FilePath - -> **FilePath**: `"file_path"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:297 - ---- - -### FilePathAndArgs - -> **FilePathAndArgs**: `"file_path_and_args"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:296 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemType.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemType.md deleted file mode 100644 index 9dc3fb28..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingItemType.md +++ /dev/null @@ -1,63 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / SettingItemType - -# Enumeration: SettingItemType - -## Enumeration Members - -### Array - -> **Array**: `4` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:291 - ---- - -### Bool - -> **Bool**: `3` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:290 - ---- - -### Button - -> **Button**: `6` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:293 - ---- - -### Int - -> **Int**: `1` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:288 - ---- - -### Object - -> **Object**: `5` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:292 - ---- - -### String - -> **String**: `2` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:289 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingStorage.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingStorage.md deleted file mode 100644 index 25508540..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/SettingStorage.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / SettingStorage - -# Enumeration: SettingStorage - -## Enumeration Members - -### Database - -> **Database**: `1` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:306 - ---- - -### File - -> **File**: `2` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:307 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ToolbarButtonLocation.md b/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ToolbarButtonLocation.md deleted file mode 100644 index c4022726..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/enumerations/ToolbarButtonLocation.md +++ /dev/null @@ -1,27 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ToolbarButtonLocation - -# Enumeration: ToolbarButtonLocation - -## Enumeration Members - -### EditorToolbar - -> **EditorToolbar**: `"editorToolbar"` - -This toolbar is right above the text editor. It applies to the note body only. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:266 - ---- - -### NoteToolbar - -> **NoteToolbar**: `"noteToolbar"` - -This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:262 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/functions/isContextMenuItemLocation.md b/packages/website/docs/en-US/dev/jpl-vite/api/functions/isContextMenuItemLocation.md deleted file mode 100644 index b3ab3cfd..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/functions/isContextMenuItemLocation.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / isContextMenuItemLocation - -# Function: isContextMenuItemLocation() - -> **isContextMenuItemLocation**(`location`): `boolean` - -## Parameters - -• **location**: [`MenuItemLocation`](../enumerations/MenuItemLocation.md) - -## Returns - -`boolean` - -## Defined in - -joplin-plugin-api/dist/types.d.ts:223 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/index.md b/packages/website/docs/en-US/dev/jpl-vite/api/index.md deleted file mode 100644 index 1e4169a8..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/index.md +++ /dev/null @@ -1,60 +0,0 @@ -[Documentation](../../packages.md) / [jpl-vite](../index.md) / api - -# api - -## Index - -### Enumerations - -- [AppType](enumerations/AppType.md) -- [ContentScriptType](enumerations/ContentScriptType.md) -- [FileSystemItem](enumerations/FileSystemItem.md) -- [ImportModuleOutputFormat](enumerations/ImportModuleOutputFormat.md) -- [MenuItemLocation](enumerations/MenuItemLocation.md) -- [ModelType](enumerations/ModelType.md) -- [SettingItemSubType](enumerations/SettingItemSubType.md) -- [SettingItemType](enumerations/SettingItemType.md) -- [SettingStorage](enumerations/SettingStorage.md) -- [ToolbarButtonLocation](enumerations/ToolbarButtonLocation.md) - -### Interfaces - -- [ButtonSpec](interfaces/ButtonSpec.md) -- [CodeMirrorContentScriptModule](interfaces/CodeMirrorContentScriptModule.md) -- [CodeMirrorControl](interfaces/CodeMirrorControl.md) -- [Command](interfaces/Command.md) -- [ContentScriptContext](interfaces/ContentScriptContext.md) -- [ContentScriptModule](interfaces/ContentScriptModule.md) -- [ContentScriptModuleLoadedEvent](interfaces/ContentScriptModuleLoadedEvent.md) -- [CreateMenuItemOptions](interfaces/CreateMenuItemOptions.md) -- [DialogResult](interfaces/DialogResult.md) -- [Disposable](interfaces/Disposable.md) -- [EditorCommand](interfaces/EditorCommand.md) -- [ExportContext](interfaces/ExportContext.md) -- [ExportModule](interfaces/ExportModule.md) -- [ExportOptions](interfaces/ExportOptions.md) -- [ImportContext](interfaces/ImportContext.md) -- [ImportModule](interfaces/ImportModule.md) -- [MarkdownItContentScriptModule](interfaces/MarkdownItContentScriptModule.md) -- [MenuItem](interfaces/MenuItem.md) -- [Rectangle](interfaces/Rectangle.md) -- [Script](interfaces/Script.md) -- [SettingItem](interfaces/SettingItem.md) -- [SettingSection](interfaces/SettingSection.md) -- [Size](interfaces/Size.md) -- [VersionInfo](interfaces/VersionInfo.md) - -### Type Aliases - -- [ButtonId](type-aliases/ButtonId.md) -- [Path](type-aliases/Path.md) -- [PostMessageHandler](type-aliases/PostMessageHandler.md) -- [ViewHandle](type-aliases/ViewHandle.md) - -### Variables - -- [joplin](variables/joplin.md) - -### Functions - -- [isContextMenuItemLocation](functions/isContextMenuItemLocation.md) diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ButtonSpec.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ButtonSpec.md deleted file mode 100644 index 142e6cc5..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ButtonSpec.md +++ /dev/null @@ -1,37 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ButtonSpec - -# Interface: ButtonSpec - -## Properties - -### id - -> **id**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:253 - ---- - -### title? - -> `optional` **title**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:254 - -## Methods - -### onClick()? - -> `optional` **onClick**(): `void` - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:255 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorContentScriptModule.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorContentScriptModule.md deleted file mode 100644 index 07e6280c..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorContentScriptModule.md +++ /dev/null @@ -1,65 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / CodeMirrorContentScriptModule - -# Interface: CodeMirrorContentScriptModule - -## Extends - -- `Omit`\<[`ContentScriptModule`](ContentScriptModule.md), `"plugin"`\> - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Inherited from - -`Omit.assets` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:405 - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Inherited from - -`Omit.onLoaded` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:403 - ---- - -### plugin() - -> **plugin**: (`codeMirrorControl`) => `void` - -#### Parameters - -• **codeMirrorControl**: [`CodeMirrorControl`](CodeMirrorControl.md) - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:440 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorControl.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorControl.md deleted file mode 100644 index 05e6d279..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CodeMirrorControl.md +++ /dev/null @@ -1,149 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / CodeMirrorControl - -# Interface: CodeMirrorControl - -## Properties - -### cm6 - -> **cm6**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:414 - ---- - -### editor - -> **editor**: `any` - -Points to a CodeMirror 6 EditorView instance. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:413 - ---- - -### joplinExtensions - -> **joplinExtensions**: `object` - -#### enableLanguageDataAutocomplete - -> **enableLanguageDataAutocomplete**: `object` - -Creates an extension that enables or disables [`languageData`-based autocompletion](https://codemirror.net/docs/ref/#autocomplete.autocompletion^config.override). - -#### enableLanguageDataAutocomplete.of() - -> **enableLanguageDataAutocomplete.of**: (`enabled`) => `any` - -##### Parameters - -• **enabled**: `boolean` - -##### Returns - -`any` - -#### completionSource() - -Returns a [CodeMirror 6 extension](https://codemirror.net/docs/ref/#state.Extension) that -registers the given [CompletionSource](https://codemirror.net/docs/ref/#autocomplete.CompletionSource). - -Use this extension rather than the built-in CodeMirror [`autocompletion`](https://codemirror.net/docs/ref/#autocomplete.autocompletion) -if you don't want to use [languageData-based autocompletion](https://codemirror.net/docs/ref/#autocomplete.autocompletion^config.override). - -Using `autocompletion({ override: [ ... ]})` causes errors when done by multiple plugins. - -##### Parameters - -• **completionSource**: `any` - -##### Returns - -`any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:420 - -## Methods - -### addExtension() - -> **addExtension**(`extension`): `void` - -`extension` should be a [CodeMirror 6 extension](https://codemirror.net/docs/ref/#state.Extension). - -#### Parameters - -• **extension**: `any` - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:416 - ---- - -### execCommand() - -> **execCommand**(`name`, ...`args`): `any` - -#### Parameters - -• **name**: `string` - -• ...**args**: `any`[] - -#### Returns - -`any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:418 - ---- - -### registerCommand() - -> **registerCommand**(`name`, `callback`): `void` - -#### Parameters - -• **name**: `string` - -• **callback**: `EditorCommandCallback` - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:419 - ---- - -### supportsCommand() - -> **supportsCommand**(`name`): `boolean` - -#### Parameters - -• **name**: `string` - -#### Returns - -`boolean` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:417 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Command.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Command.md deleted file mode 100644 index 8d533c11..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Command.md +++ /dev/null @@ -1,98 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Command - -# Interface: Command - -## Properties - -### enabledCondition? - -> `optional` **enabledCondition**: `string` - -Defines whether the command should be enabled or disabled, which in turns -affects the enabled state of any associated button or menu item. - -The condition should be expressed as a "when-clause" (as in Visual Studio -Code). It's a simple boolean expression that evaluates to `true` or -`false`. It supports the following operators: - -| Operator | Symbol | Example | -| ---------- | ------ | -------------------------------------- | -| Equality | == | "editorType == markdown" | -| Inequality | != | "currentScreen != config" | -| Or | \|\| | "noteIsTodo \|\| noteTodoCompleted" | -| And | && | "oneNoteSelected && !inConflictFolder" | - -Joplin, unlike VSCode, also supports parentheses, which allows creating -more complex expressions such as `cond1 || (cond2 && cond3)`. Only one -level of parentheses is possible (nested ones aren't supported). - -Currently the supported context variables aren't documented, but you can -find the list below: - -- [Global When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/lib/services/commands/stateToWhenClauseContext.ts) -- [Desktop app When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/app-desktop/services/commands/stateToWhenClauseContext.ts) - -Note: Commands are enabled by default unless you use this property. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:48 - ---- - -### iconName? - -> `optional` **iconName**: `string` - -Icon to be used on toolbar buttons for example - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:16 - ---- - -### label? - -> `optional` **label**: `string` - -Label to be displayed on menu items or keyboard shortcut editor for example. -If it is missing, it's assumed it's a private command, to be called programmatically only. -In that case the command will not appear in the shortcut editor or command panel, and logically -should not be used as a menu item. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:12 - ---- - -### name - -> **name**: `string` - -Name of command - must be globally unique - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:5 - -## Methods - -### execute() - -> **execute**(...`args`): `Promise`\<`any`\> - -Code to be ran when the command is executed. It may return a result. - -#### Parameters - -• ...**args**: `any`[] - -#### Returns - -`Promise`\<`any`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:20 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptContext.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptContext.md deleted file mode 100644 index 8a34e26a..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptContext.md +++ /dev/null @@ -1,41 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ContentScriptContext - -# Interface: ContentScriptContext - -When a content script is initialised, it receives a `context` object. - -## Properties - -### contentScriptId - -> **contentScriptId**: `string` - -The content script ID, which may be necessary to post messages - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:393 - ---- - -### pluginId - -> **pluginId**: `string` - -The plugin ID that registered this content script - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:389 - ---- - -### postMessage - -> **postMessage**: [`PostMessageHandler`](../type-aliases/PostMessageHandler.md) - -Can be used by CodeMirror content scripts to post a message to the plugin - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:397 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModule.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModule.md deleted file mode 100644 index 92763f15..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModule.md +++ /dev/null @@ -1,49 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ContentScriptModule - -# Interface: ContentScriptModule - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:405 - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:403 - ---- - -### plugin() - -> **plugin**: () => `any` - -#### Returns - -`any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:404 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModuleLoadedEvent.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModuleLoadedEvent.md deleted file mode 100644 index 80e14c03..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ContentScriptModuleLoadedEvent.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ContentScriptModuleLoadedEvent - -# Interface: ContentScriptModuleLoadedEvent - -## Properties - -### userData? - -> `optional` **userData**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:400 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CreateMenuItemOptions.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CreateMenuItemOptions.md deleted file mode 100644 index b1a1e1ac..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/CreateMenuItemOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / CreateMenuItemOptions - -# Interface: CreateMenuItemOptions - -## Properties - -### accelerator - -> **accelerator**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:187 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/DialogResult.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/DialogResult.md deleted file mode 100644 index fd0d37fb..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/DialogResult.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / DialogResult - -# Interface: DialogResult - -## Properties - -### formData? - -> `optional` **formData**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:275 - ---- - -### id - -> **id**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:274 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Disposable.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Disposable.md deleted file mode 100644 index a83fb2c6..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Disposable.md +++ /dev/null @@ -1,3 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Disposable - -# Interface: Disposable diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/EditorCommand.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/EditorCommand.md deleted file mode 100644 index 0fc09e7b..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/EditorCommand.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / EditorCommand - -# Interface: EditorCommand - -## Properties - -### name - -> **name**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:270 - ---- - -### value? - -> `optional` **value**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:271 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportContext.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportContext.md deleted file mode 100644 index c243ee15..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportContext.md +++ /dev/null @@ -1,35 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ExportContext - -# Interface: ExportContext - -## Properties - -### destPath - -> **destPath**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:145 - ---- - -### options - -> **options**: [`ExportOptions`](ExportOptions.md) - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:146 - ---- - -### userData? - -> `optional` **userData**: `any` - -You can attach your own custom data using this property - it will then be passed to each event handler, allowing you to keep state from one event to the next. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:150 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportModule.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportModule.md deleted file mode 100644 index b0c9d059..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportModule.md +++ /dev/null @@ -1,159 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ExportModule - -# Interface: ExportModule - -Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/json_export) for an example. - -In general, all the event handlers you'll need to implement take a `context` object as a first argument. This object will contain the export or import path as well as various optional properties, such as which notes or notebooks need to be exported. - -To get a better sense of what it will contain it can be useful to print it using `console.info(context)`. - -## Properties - -### description - -> **description**: `string` - -The description that will appear in the UI, for example in the menu item. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:73 - ---- - -### fileExtensions? - -> `optional` **fileExtensions**: `string`[] - -The extensions of the files exported by your module. For example, it is `["htm", "html"]` for the HTML module, and just `["jex"]` for the JEX module. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:87 - ---- - -### format - -> **format**: `string` - -The format to be exported, eg "enex", "jex", "json", etc. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:69 - ---- - -### isNoteArchive - -> **isNoteArchive**: `boolean` - -Only applies to single file exporters or importers -It tells whether the format can package multiple notes into one file. -For example JEX or ENEX can, but HTML cannot. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:83 - ---- - -### target - -> **target**: [`FileSystemItem`](../enumerations/FileSystemItem.md) - -Whether the module will export a single file or multiple files in a directory. It affects the open dialog that will be presented to the user when using your exporter. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:77 - -## Methods - -### onClose() - -> **onClose**(`context`): `Promise`\<`void`\> - -Called when the export process is done. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:103 - ---- - -### onInit() - -> **onInit**(`context`): `Promise`\<`void`\> - -Called when the export process starts. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:91 - ---- - -### onProcessItem() - -> **onProcessItem**(`context`, `itemType`, `item`): `Promise`\<`void`\> - -Called when an item needs to be processed. An "item" can be any Joplin object, such as a note, a folder, a notebook, etc. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -• **itemType**: `number` - -• **item**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:95 - ---- - -### onProcessResource() - -> **onProcessResource**(`context`, `resource`, `filePath`): `Promise`\<`void`\> - -Called when a resource file needs to be exported. - -#### Parameters - -• **context**: [`ExportContext`](ExportContext.md) - -• **resource**: `any` - -• **filePath**: `string` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:99 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportOptions.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportOptions.md deleted file mode 100644 index 67102440..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ExportOptions.md +++ /dev/null @@ -1,53 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ExportOptions - -# Interface: ExportOptions - -## Properties - -### format? - -> `optional` **format**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:138 - ---- - -### path? - -> `optional` **path**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:139 - ---- - -### sourceFolderIds? - -> `optional` **sourceFolderIds**: `string`[] - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:140 - ---- - -### sourceNoteIds? - -> `optional` **sourceNoteIds**: `string`[] - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:141 - ---- - -### target? - -> `optional` **target**: [`FileSystemItem`](../enumerations/FileSystemItem.md) - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:142 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportContext.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportContext.md deleted file mode 100644 index 56d36f58..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportContext.md +++ /dev/null @@ -1,33 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ImportContext - -# Interface: ImportContext - -## Properties - -### options - -> **options**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:154 - ---- - -### sourcePath - -> **sourcePath**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:153 - ---- - -### warnings - -> **warnings**: `string`[] - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:155 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportModule.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportModule.md deleted file mode 100644 index aba0b6f9..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/ImportModule.md +++ /dev/null @@ -1,97 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ImportModule - -# Interface: ImportModule - -## Properties - -### description - -> **description**: `string` - -The description that will appear in the UI, for example in the menu item. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:113 - ---- - -### fileExtensions? - -> `optional` **fileExtensions**: `string`[] - -Tells the file extensions of the exported files. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:127 - ---- - -### format - -> **format**: `string` - -The format to be exported, eg "enex", "jex", "json", etc. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:109 - ---- - -### isNoteArchive - -> **isNoteArchive**: `boolean` - -Only applies to single file exporters or importers -It tells whether the format can package multiple notes into one file. -For example JEX or ENEX can, but HTML cannot. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:119 - ---- - -### outputFormat? - -> `optional` **outputFormat**: [`ImportModuleOutputFormat`](../enumerations/ImportModuleOutputFormat.md) - -Tells the type of notes that will be generated, either HTML or Markdown (default). - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:131 - ---- - -### sources - -> **sources**: [`FileSystemItem`](../enumerations/FileSystemItem.md)[] - -The type of sources that are supported by the module. Tells whether the module can import files or directories or both. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:123 - -## Methods - -### onExec() - -> **onExec**(`context`): `Promise`\<`void`\> - -Called when the import process starts. There is only one event handler within which you should import the complete data. - -#### Parameters - -• **context**: [`ImportContext`](ImportContext.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:135 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MarkdownItContentScriptModule.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MarkdownItContentScriptModule.md deleted file mode 100644 index 3ae158ff..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MarkdownItContentScriptModule.md +++ /dev/null @@ -1,67 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / MarkdownItContentScriptModule - -# Interface: MarkdownItContentScriptModule - -## Extends - -- `Omit`\<[`ContentScriptModule`](ContentScriptModule.md), `"plugin"`\> - -## Properties - -### assets()? - -> `optional` **assets**: () => `void` - -#### Returns - -`void` - -#### Inherited from - -`Omit.assets` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:405 - ---- - -### onLoaded()? - -> `optional` **onLoaded**: (`event`) => `void` - -#### Parameters - -• **event**: [`ContentScriptModuleLoadedEvent`](ContentScriptModuleLoadedEvent.md) - -#### Returns - -`void` - -#### Inherited from - -`Omit.onLoaded` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:403 - ---- - -### plugin() - -> **plugin**: (`markdownIt`, `options`) => `any` - -#### Parameters - -• **markdownIt**: `any` - -• **options**: `any` - -#### Returns - -`any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:408 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MenuItem.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MenuItem.md deleted file mode 100644 index 4888ea48..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/MenuItem.md +++ /dev/null @@ -1,77 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / MenuItem - -# Interface: MenuItem - -## Properties - -### accelerator? - -> `optional` **accelerator**: `string` - -Accelerator associated with the menu item - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:242 - ---- - -### commandArgs? - -> `optional` **commandArgs**: `any`[] - -Arguments that should be passed to the command. They will be as rest -parameters. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:234 - ---- - -### commandName? - -> `optional` **commandName**: `string` - -Command that should be associated with the menu item. All menu item should -have a command associated with them unless they are a sub-menu. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:229 - ---- - -### label? - -> `optional` **label**: `string` - -Menu item label. If not specified, the command label will be used instead. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:250 - ---- - -### submenu? - -> `optional` **submenu**: [`MenuItem`](MenuItem.md)[] - -Menu items that should appear below this menu item. Allows creating a menu tree. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:246 - ---- - -### type? - -> `optional` **type**: `"normal"` \| `"separator"` \| `"submenu"` \| `"checkbox"` \| `"radio"` - -Set to "separator" to create a divider line - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:238 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Rectangle.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Rectangle.md deleted file mode 100644 index 46dcfab0..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Rectangle.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Rectangle - -# Interface: Rectangle - -## Properties - -### height? - -> `optional` **height**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:285 - ---- - -### width? - -> `optional` **width**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:284 - ---- - -### x? - -> `optional` **x**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:282 - ---- - -### y? - -> `optional` **y**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:283 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Script.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Script.md deleted file mode 100644 index 33029112..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Script.md +++ /dev/null @@ -1,21 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Script - -# Interface: Script - -## Methods - -### onStart()? - -> `optional` **onStart**(`event`): `Promise`\<`void`\> - -#### Parameters - -• **event**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:158 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingItem.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingItem.md deleted file mode 100644 index 8cc7f0bb..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingItem.md +++ /dev/null @@ -1,193 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / SettingItem - -# Interface: SettingItem - -## Properties - -### advanced? - -> `optional` **advanced**: `boolean` - -An advanced setting will be moved under the "Advanced" button in the -config screen. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:354 - ---- - -### appTypes? - -> `optional` **appTypes**: [`AppType`](../enumerations/AppType.md)[] - -Reserved property. Not used at the moment. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:344 - ---- - -### description? - -> `optional` **description**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:318 - ---- - -### isEnum? - -> `optional` **isEnum**: `boolean` - -To create a setting with multiple options, set this property to `true`. -That setting will render as a dropdown list in the configuration screen. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:335 - ---- - -### label - -> **label**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:317 - ---- - -### maximum? - -> `optional` **maximum**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:360 - ---- - -### minimum? - -> `optional` **minimum**: `number` - -Set the min, max and step values if you want to restrict an int setting -to a particular range. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:359 - ---- - -### options? - -> `optional` **options**: `Record`\<`any`, `any`\> - -This property is required when `isEnum` is `true`. In which case, it -should contain a map of value => label. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:340 - ---- - -### public - -> **public**: `boolean` - -A public setting will appear in the Configuration screen and will be -modifiable by the user. A private setting however will not appear there, -and can only be changed programmatically. You may use this to store some -values that you do not want to directly expose. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:325 - ---- - -### section? - -> `optional` **section**: `string` - -You would usually set this to a section you would have created -specifically for the plugin. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:330 - ---- - -### secure? - -> `optional` **secure**: `boolean` - -Set this to `true` to store secure data, such as passwords. Any such -setting will be stored in the system keychain if one is available. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:349 - ---- - -### step? - -> `optional` **step**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:361 - ---- - -### storage? - -> `optional` **storage**: [`SettingStorage`](../enumerations/SettingStorage.md) - -Either store the setting in the database or in settings.json. Defaults to database. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:365 - ---- - -### subType? - -> `optional` **subType**: [`SettingItemSubType`](../enumerations/SettingItemSubType.md) - -Currently only used to display a file or directory selector. Always set -`type` to `SettingItemType.String` when using this property. - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:316 - ---- - -### type - -> **type**: [`SettingItemType`](../enumerations/SettingItemType.md) - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:311 - ---- - -### value - -> **value**: `any` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:310 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingSection.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingSection.md deleted file mode 100644 index 72a62439..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/SettingSection.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / SettingSection - -# Interface: SettingSection - -## Properties - -### description? - -> `optional` **description**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:370 - ---- - -### iconName? - -> `optional` **iconName**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:369 - ---- - -### label - -> **label**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:368 - ---- - -### name? - -> `optional` **name**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:371 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Size.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Size.md deleted file mode 100644 index 10fc3355..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/Size.md +++ /dev/null @@ -1,23 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Size - -# Interface: Size - -## Properties - -### height? - -> `optional` **height**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:279 - ---- - -### width? - -> `optional` **width**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:278 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/VersionInfo.md b/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/VersionInfo.md deleted file mode 100644 index 64ef4963..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/interfaces/VersionInfo.md +++ /dev/null @@ -1,43 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / VersionInfo - -# Interface: VersionInfo - -## Properties - -### platform - -> **platform**: `"desktop"` \| `"mobile"` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:184 - ---- - -### profileVersion - -> **profileVersion**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:182 - ---- - -### syncVersion - -> **syncVersion**: `number` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:183 - ---- - -### version - -> **version**: `string` - -#### Defined in - -joplin-plugin-api/dist/types.d.ts:181 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ButtonId.md b/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ButtonId.md deleted file mode 100644 index 82c37397..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ButtonId.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ButtonId - -# Type Alias: ButtonId - -> **ButtonId**: `string` - -## Defined in - -joplin-plugin-api/dist/types.d.ts:257 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/Path.md b/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/Path.md deleted file mode 100644 index 807dc827..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/Path.md +++ /dev/null @@ -1,15 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / Path - -# Type Alias: Path - -> **Path**: `string`[] - -An array of at least one element and at most three elements. - -- **[0]**: Resource name (eg. "notes", "folders", "tags", etc.) -- **[1]**: (Optional) Resource ID. -- **[2]**: (Optional) Resource link. - -## Defined in - -joplin-plugin-api/dist/types.d.ts:380 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/PostMessageHandler.md b/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/PostMessageHandler.md deleted file mode 100644 index 61648d95..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/PostMessageHandler.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / PostMessageHandler - -# Type Alias: PostMessageHandler() - -> **PostMessageHandler**: (`message`) => `Promise`\<`any`\> - -## Parameters - -• **message**: `any` - -## Returns - -`Promise`\<`any`\> - -## Defined in - -joplin-plugin-api/dist/types.d.ts:381 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ViewHandle.md b/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ViewHandle.md deleted file mode 100644 index ea1565e6..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/type-aliases/ViewHandle.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / ViewHandle - -# Type Alias: ViewHandle - -> **ViewHandle**: `string` - -## Defined in - -joplin-plugin-api/dist/types.d.ts:268 diff --git a/packages/website/docs/en-US/dev/jpl-vite/api/variables/joplin.md b/packages/website/docs/en-US/dev/jpl-vite/api/variables/joplin.md deleted file mode 100644 index dd637641..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/api/variables/joplin.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [api](../index.md) / joplin - -# Variable: joplin - -> `const` **joplin**: `Joplin` - -## Defined in - -joplin-plugin-api/dist/index.d.ts:3 diff --git a/packages/website/docs/en-US/dev/jpl-vite/index.md b/packages/website/docs/en-US/dev/jpl-vite/index.md deleted file mode 100644 index 3f9a44d8..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index.md +++ /dev/null @@ -1,11 +0,0 @@ -[Documentation](../packages.md) / jpl-vite - -# jpl-vite(internal) - -Joplin plugin development based on Vite. - -## Features - -- `jpl`: Compile the plugin in watch mode for development and debugging, generating `dist/*.[js,json]` -- `jpl build`: Compile the plugin in production mode for release, generating `publish/*.jpl` -- `jpl dev`: Start a vite development server to debug webview UI in the browser diff --git a/packages/website/docs/en-US/dev/jpl-vite/index/functions/defineConfig.md b/packages/website/docs/en-US/dev/jpl-vite/index/functions/defineConfig.md deleted file mode 100644 index 2bfc5e50..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index/functions/defineConfig.md +++ /dev/null @@ -1,17 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [index](../index.md) / defineConfig - -# Function: defineConfig() - -> **defineConfig**(`config`): [`PluginConfig`](../interfaces/PluginConfig.md) - -## Parameters - -• **config**: [`PluginConfig`](../interfaces/PluginConfig.md) - -## Returns - -[`PluginConfig`](../interfaces/PluginConfig.md) - -## Defined in - -[jpl-vite/src/index.ts:57](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L57) diff --git a/packages/website/docs/en-US/dev/jpl-vite/index/functions/getEnv.md b/packages/website/docs/en-US/dev/jpl-vite/index/functions/getEnv.md deleted file mode 100644 index 09773b5a..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index/functions/getEnv.md +++ /dev/null @@ -1,13 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [index](../index.md) / getEnv - -# Function: getEnv() - -> **getEnv**(): `"main"` \| `"webview"` \| `undefined` - -## Returns - -`"main"` \| `"webview"` \| `undefined` - -## Defined in - -[jpl-vite/src/index.ts:61](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L61) diff --git a/packages/website/docs/en-US/dev/jpl-vite/index/index.md b/packages/website/docs/en-US/dev/jpl-vite/index/index.md deleted file mode 100644 index 911934f0..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index/index.md +++ /dev/null @@ -1,15 +0,0 @@ -[Documentation](../../packages.md) / [jpl-vite](../index.md) / index - -# index - -## Index - -### Interfaces - -- [PluginConfig](interfaces/PluginConfig.md) -- [ResolvedPluginConfig](interfaces/ResolvedPluginConfig.md) - -### Functions - -- [defineConfig](functions/defineConfig.md) -- [getEnv](functions/getEnv.md) diff --git a/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/PluginConfig.md b/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/PluginConfig.md deleted file mode 100644 index 00019f1e..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/PluginConfig.md +++ /dev/null @@ -1,245 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [index](../index.md) / PluginConfig - -# Interface: PluginConfig - -## Extends - -- `PluginManifest` - -## Extended by - -- [`ResolvedPluginConfig`](ResolvedPluginConfig.md) - -## Properties - -### app_min_version - -> **app_min_version**: `string` - -#### Inherited from - -`PluginManifest.app_min_version` - -#### Defined in - -[jpl-vite/src/index.ts:34](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L34) - ---- - -### app_min_version_mobile? - -> `optional` **app_min_version_mobile**: `string` - -#### Inherited from - -`PluginManifest.app_min_version_mobile` - -#### Defined in - -[jpl-vite/src/index.ts:35](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L35) - ---- - -### author? - -> `optional` **author**: `string` - -#### Inherited from - -`PluginManifest.author` - -#### Defined in - -[jpl-vite/src/index.ts:39](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L39) - ---- - -### categories? - -> `optional` **categories**: `Category`[] - -#### Inherited from - -`PluginManifest.categories` - -#### Defined in - -[jpl-vite/src/index.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L43) - ---- - -### description? - -> `optional` **description**: `string` - -#### Inherited from - -`PluginManifest.description` - -#### Defined in - -[jpl-vite/src/index.ts:38](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L38) - ---- - -### homepage_url? - -> `optional` **homepage_url**: `string` - -#### Inherited from - -`PluginManifest.homepage_url` - -#### Defined in - -[jpl-vite/src/index.ts:41](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L41) - ---- - -### icons? - -> `optional` **icons**: `Icons` - -#### Inherited from - -`PluginManifest.icons` - -#### Defined in - -[jpl-vite/src/index.ts:45](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L45) - ---- - -### id - -> **id**: `string` - -#### Inherited from - -`PluginManifest.id` - -#### Defined in - -[jpl-vite/src/index.ts:31](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L31) - ---- - -### keywords? - -> `optional` **keywords**: `string`[] - -#### Inherited from - -`PluginManifest.keywords` - -#### Defined in - -[jpl-vite/src/index.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L40) - ---- - -### manifest_version - -> **manifest_version**: `1` - -#### Inherited from - -`PluginManifest.manifest_version` - -#### Defined in - -[jpl-vite/src/index.ts:32](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L32) - ---- - -### name - -> **name**: `string` - -#### Inherited from - -`PluginManifest.name` - -#### Defined in - -[jpl-vite/src/index.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L33) - ---- - -### platforms? - -> `optional` **platforms**: `Platform`[] - -#### Inherited from - -`PluginManifest.platforms` - -#### Defined in - -[jpl-vite/src/index.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L37) - ---- - -### promo_tile? - -> `optional` **promo_tile**: `Image` - -#### Inherited from - -`PluginManifest.promo_tile` - -#### Defined in - -[jpl-vite/src/index.ts:46](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L46) - ---- - -### repository_url? - -> `optional` **repository_url**: `string` - -#### Inherited from - -`PluginManifest.repository_url` - -#### Defined in - -[jpl-vite/src/index.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L42) - ---- - -### screenshots? - -> `optional` **screenshots**: `Image`[] - -#### Inherited from - -`PluginManifest.screenshots` - -#### Defined in - -[jpl-vite/src/index.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L44) - ---- - -### version? - -> `optional` **version**: `string` - -#### Inherited from - -`PluginManifest.version` - -#### Defined in - -[jpl-vite/src/index.ts:36](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L36) - ---- - -### vite? - -> `optional` **vite**: `UserConfig` - -#### Defined in - -[jpl-vite/src/index.ts:50](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L50) diff --git a/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/ResolvedPluginConfig.md b/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/ResolvedPluginConfig.md deleted file mode 100644 index 53dced5a..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/index/interfaces/ResolvedPluginConfig.md +++ /dev/null @@ -1,255 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [index](../index.md) / ResolvedPluginConfig - -# Interface: ResolvedPluginConfig - -## Extends - -- [`PluginConfig`](PluginConfig.md) - -## Properties - -### app_min_version - -> **app_min_version**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`app_min_version`](PluginConfig.md#app-min-version) - -#### Defined in - -[jpl-vite/src/index.ts:34](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L34) - ---- - -### app_min_version_mobile? - -> `optional` **app_min_version_mobile**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`app_min_version_mobile`](PluginConfig.md#app-min-version-mobile) - -#### Defined in - -[jpl-vite/src/index.ts:35](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L35) - ---- - -### author? - -> `optional` **author**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`author`](PluginConfig.md#author) - -#### Defined in - -[jpl-vite/src/index.ts:39](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L39) - ---- - -### categories? - -> `optional` **categories**: `Category`[] - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`categories`](PluginConfig.md#categories) - -#### Defined in - -[jpl-vite/src/index.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L43) - ---- - -### description? - -> `optional` **description**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`description`](PluginConfig.md#description) - -#### Defined in - -[jpl-vite/src/index.ts:38](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L38) - ---- - -### homepage_url? - -> `optional` **homepage_url**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`homepage_url`](PluginConfig.md#homepage-url) - -#### Defined in - -[jpl-vite/src/index.ts:41](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L41) - ---- - -### icons? - -> `optional` **icons**: `Icons` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`icons`](PluginConfig.md#icons) - -#### Defined in - -[jpl-vite/src/index.ts:45](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L45) - ---- - -### id - -> **id**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`id`](PluginConfig.md#id) - -#### Defined in - -[jpl-vite/src/index.ts:31](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L31) - ---- - -### keywords? - -> `optional` **keywords**: `string`[] - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`keywords`](PluginConfig.md#keywords) - -#### Defined in - -[jpl-vite/src/index.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L40) - ---- - -### manifest_version - -> **manifest_version**: `1` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`manifest_version`](PluginConfig.md#manifest-version) - -#### Defined in - -[jpl-vite/src/index.ts:32](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L32) - ---- - -### name - -> **name**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`name`](PluginConfig.md#name) - -#### Defined in - -[jpl-vite/src/index.ts:33](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L33) - ---- - -### platforms? - -> `optional` **platforms**: `Platform`[] - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`platforms`](PluginConfig.md#platforms) - -#### Defined in - -[jpl-vite/src/index.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L37) - ---- - -### promo_tile? - -> `optional` **promo_tile**: `Image` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`promo_tile`](PluginConfig.md#promo-tile) - -#### Defined in - -[jpl-vite/src/index.ts:46](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L46) - ---- - -### repository_url? - -> `optional` **repository_url**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`repository_url`](PluginConfig.md#repository-url) - -#### Defined in - -[jpl-vite/src/index.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L42) - ---- - -### root - -> **root**: `string` - -#### Defined in - -[jpl-vite/src/index.ts:54](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L54) - ---- - -### screenshots? - -> `optional` **screenshots**: `Image`[] - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`screenshots`](PluginConfig.md#screenshots) - -#### Defined in - -[jpl-vite/src/index.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L44) - ---- - -### version? - -> `optional` **version**: `string` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`version`](PluginConfig.md#version) - -#### Defined in - -[jpl-vite/src/index.ts:36](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L36) - ---- - -### vite? - -> `optional` **vite**: `UserConfig` - -#### Inherited from - -[`PluginConfig`](PluginConfig.md).[`vite`](PluginConfig.md#vite) - -#### Defined in - -[jpl-vite/src/index.ts:50](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/index.ts#L50) diff --git a/packages/website/docs/en-US/dev/jpl-vite/messaging/functions/defineExtensionMessaging.md b/packages/website/docs/en-US/dev/jpl-vite/messaging/functions/defineExtensionMessaging.md deleted file mode 100644 index c6bb5448..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/messaging/functions/defineExtensionMessaging.md +++ /dev/null @@ -1,21 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [messaging](../index.md) / defineExtensionMessaging - -# Function: defineExtensionMessaging() - -> **defineExtensionMessaging**\<`TProtocolMap`\>(`viewHandle`): `ExtensionMessenger`\<`TProtocolMap`\> - -## Type Parameters - -• **TProtocolMap** _extends_ `Record`\<`string`, `any`\> - -## Parameters - -• **viewHandle**: `string` - -## Returns - -`ExtensionMessenger`\<`TProtocolMap`\> - -## Defined in - -[jpl-vite/src/messaging.ts:54](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/messaging.ts#L54) diff --git a/packages/website/docs/en-US/dev/jpl-vite/messaging/index.md b/packages/website/docs/en-US/dev/jpl-vite/messaging/index.md deleted file mode 100644 index 4fe836db..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/messaging/index.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [jpl-vite](../index.md) / messaging - -# messaging - -## Index - -### Functions - -- [defineExtensionMessaging](functions/defineExtensionMessaging.md) diff --git a/packages/website/docs/en-US/dev/jpl-vite/modules.md b/packages/website/docs/en-US/dev/jpl-vite/modules.md deleted file mode 100644 index 2d3fdf50..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/modules.md +++ /dev/null @@ -1,10 +0,0 @@ -[Documentation](../packages.md) / jpl-vite - -# jpl-vite - -## Modules - -- [api](api/index.md) -- [index](index/index.md) -- [messaging](messaging/index.md) -- [webview](webview/index.md) diff --git a/packages/website/docs/en-US/dev/jpl-vite/webview/index.md b/packages/website/docs/en-US/dev/jpl-vite/webview/index.md deleted file mode 100644 index df3681ed..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/webview/index.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../packages.md) / [jpl-vite](../index.md) / webview - -# webview - -## Index - -### Variables - -- [webviewApi](variables/webviewApi.md) diff --git a/packages/website/docs/en-US/dev/jpl-vite/webview/variables/webviewApi.md b/packages/website/docs/en-US/dev/jpl-vite/webview/variables/webviewApi.md deleted file mode 100644 index ee775ebe..00000000 --- a/packages/website/docs/en-US/dev/jpl-vite/webview/variables/webviewApi.md +++ /dev/null @@ -1,9 +0,0 @@ -[Documentation](../../../packages.md) / [jpl-vite](../../index.md) / [webview](../index.md) / webviewApi - -# Variable: webviewApi - -> `const` **webviewApi**: _typeof_ `webviewApi` - -## Defined in - -[jpl-vite/src/webview.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/jpl-vite/src/webview.ts#L6) diff --git a/packages/website/docs/en-US/dev/packages.md b/packages/website/docs/en-US/dev/packages.md deleted file mode 100644 index 43049944..00000000 --- a/packages/website/docs/en-US/dev/packages.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation - -## Packages - -- [joplin-api](joplin-api/index.md) -- [joplin-plugin-api](joplin-plugin-api/index.md) -- [jpl-vite](jpl-vite/index.md) diff --git a/packages/website/docs/en-US/dev/typedoc-sidebar.json b/packages/website/docs/en-US/dev/typedoc-sidebar.json deleted file mode 100644 index e146198f..00000000 --- a/packages/website/docs/en-US/dev/typedoc-sidebar.json +++ /dev/null @@ -1,747 +0,0 @@ -[ - { - "text": "joplin-api", - "link": "/en-US/dev/joplin-api/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "NoteActionEnum", - "link": "/en-US/dev/joplin-api/enumerations/NoteActionEnum.md" - }, - { - "text": "ResourceActionEnum", - "link": "/en-US/dev/joplin-api/enumerations/ResourceActionEnum.md" - }, - { - "text": "TypeEnum", - "link": "/en-US/dev/joplin-api/enumerations/TypeEnum.md" - } - ] - }, - { - "text": "Classes", - "collapsed": true, - "items": [ - { - "text": "Config", - "link": "/en-US/dev/joplin-api/classes/Config.md" - }, - { - "text": "EventApi", - "link": "/en-US/dev/joplin-api/classes/EventApi.md" - }, - { - "text": "FolderApi", - "link": "/en-US/dev/joplin-api/classes/FolderApi.md" - }, - { - "text": "FolderExtApi", - "link": "/en-US/dev/joplin-api/classes/FolderExtApi.md" - }, - { - "text": "JoplinApi", - "link": "/en-US/dev/joplin-api/classes/JoplinApi.md" - }, - { - "text": "JoplinApiGenerator", - "link": "/en-US/dev/joplin-api/classes/JoplinApiGenerator.md" - }, - { - "text": "NoteActionApi", - "link": "/en-US/dev/joplin-api/classes/NoteActionApi.md" - }, - { - "text": "NoteApi", - "link": "/en-US/dev/joplin-api/classes/NoteApi.md" - }, - { - "text": "NoteExtApi", - "link": "/en-US/dev/joplin-api/classes/NoteExtApi.md" - }, - { - "text": "PageUtil", - "link": "/en-US/dev/joplin-api/classes/PageUtil.md" - }, - { - "text": "ResourceActionApi", - "link": "/en-US/dev/joplin-api/classes/ResourceActionApi.md" - }, - { - "text": "ResourceApi", - "link": "/en-US/dev/joplin-api/classes/ResourceApi.md" - }, - { - "text": "SearchApi", - "link": "/en-US/dev/joplin-api/classes/SearchApi.md" - }, - { - "text": "TagApi", - "link": "/en-US/dev/joplin-api/classes/TagApi.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "Api", - "link": "/en-US/dev/joplin-api/interfaces/Api.md" - }, - { - "text": "BaseProperties", - "link": "/en-US/dev/joplin-api/interfaces/BaseProperties.md" - }, - { - "text": "CommonType", - "link": "/en-US/dev/joplin-api/interfaces/CommonType.md" - }, - { - "text": "EventProperties", - "link": "/en-US/dev/joplin-api/interfaces/EventProperties.md" - }, - { - "text": "FieldsParam", - "link": "/en-US/dev/joplin-api/interfaces/FieldsParam.md" - }, - { - "text": "FolderListRecursionGetTree", - "link": "/en-US/dev/joplin-api/interfaces/FolderListRecursionGetTree.md" - }, - { - "text": "FolderProperties", - "link": "/en-US/dev/joplin-api/interfaces/FolderProperties.md" - }, - { - "text": "NoteProperties", - "link": "/en-US/dev/joplin-api/interfaces/NoteProperties.md" - }, - { - "text": "PageParam", - "link": "/en-US/dev/joplin-api/interfaces/PageParam.md" - }, - { - "text": "PageRes", - "link": "/en-US/dev/joplin-api/interfaces/PageRes.md" - }, - { - "text": "ResourceProperties", - "link": "/en-US/dev/joplin-api/interfaces/ResourceProperties.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "ApiConfig", - "link": "/en-US/dev/joplin-api/type-aliases/ApiConfig.md" - }, - { - "text": "EventGetRes", - "link": "/en-US/dev/joplin-api/type-aliases/EventGetRes.md" - }, - { - "text": "EventListRes", - "link": "/en-US/dev/joplin-api/type-aliases/EventListRes.md" - }, - { - "text": "FolderCreateRes", - "link": "/en-US/dev/joplin-api/type-aliases/FolderCreateRes.md" - }, - { - "text": "FolderGetRes", - "link": "/en-US/dev/joplin-api/type-aliases/FolderGetRes.md" - }, - { - "text": "FolderListAllRes", - "link": "/en-US/dev/joplin-api/type-aliases/FolderListAllRes.md" - }, - { - "text": "FolderListRes", - "link": "/en-US/dev/joplin-api/type-aliases/FolderListRes.md" - }, - { - "text": "FolderUpdateRes", - "link": "/en-US/dev/joplin-api/type-aliases/FolderUpdateRes.md" - }, - { - "text": "NoteCreateRes", - "link": "/en-US/dev/joplin-api/type-aliases/NoteCreateRes.md" - }, - { - "text": "NoteGetRes", - "link": "/en-US/dev/joplin-api/type-aliases/NoteGetRes.md" - }, - { - "text": "NoteTagRelated", - "link": "/en-US/dev/joplin-api/type-aliases/NoteTagRelated.md" - }, - { - "text": "NoteUpdateRes", - "link": "/en-US/dev/joplin-api/type-aliases/NoteUpdateRes.md" - }, - { - "text": "ResourceGetRes", - "link": "/en-US/dev/joplin-api/type-aliases/ResourceGetRes.md" - }, - { - "text": "TagGetRes", - "link": "/en-US/dev/joplin-api/type-aliases/TagGetRes.md" - }, - { - "text": "TagProperties", - "link": "/en-US/dev/joplin-api/type-aliases/TagProperties.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "actionApi", - "link": "/en-US/dev/joplin-api/variables/actionApi.md" - }, - { - "text": "ajax", - "link": "/en-US/dev/joplin-api/variables/ajax.md" - }, - { - "text": "config", - "link": "/en-US/dev/joplin-api/variables/config.md" - }, - { - "text": "eventApi", - "link": "/en-US/dev/joplin-api/variables/eventApi.md" - }, - { - "text": "folderApi", - "link": "/en-US/dev/joplin-api/variables/folderApi.md" - }, - { - "text": "folderExtApi", - "link": "/en-US/dev/joplin-api/variables/folderExtApi.md" - }, - { - "text": "joplinApi", - "link": "/en-US/dev/joplin-api/variables/joplinApi.md" - }, - { - "text": "noteActionApi", - "link": "/en-US/dev/joplin-api/variables/noteActionApi.md" - }, - { - "text": "noteApi", - "link": "/en-US/dev/joplin-api/variables/noteApi.md" - }, - { - "text": "noteExtApi", - "link": "/en-US/dev/joplin-api/variables/noteExtApi.md" - }, - { - "text": "resourceActionApi", - "link": "/en-US/dev/joplin-api/variables/resourceActionApi.md" - }, - { - "text": "resourceApi", - "link": "/en-US/dev/joplin-api/variables/resourceApi.md" - }, - { - "text": "searchApi", - "link": "/en-US/dev/joplin-api/variables/searchApi.md" - }, - { - "text": "tagApi", - "link": "/en-US/dev/joplin-api/variables/tagApi.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "joplinDataApi", - "link": "/en-US/dev/joplin-api/functions/joplinDataApi.md" - } - ] - } - ] - }, - { - "text": "joplin-plugin-api", - "link": "/en-US/dev/joplin-plugin-api/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "AppType", - "link": "/en-US/dev/joplin-plugin-api/enumerations/AppType.md" - }, - { - "text": "ContentScriptType", - "link": "/en-US/dev/joplin-plugin-api/enumerations/ContentScriptType.md" - }, - { - "text": "FileSystemItem", - "link": "/en-US/dev/joplin-plugin-api/enumerations/FileSystemItem.md" - }, - { - "text": "ImportModuleOutputFormat", - "link": "/en-US/dev/joplin-plugin-api/enumerations/ImportModuleOutputFormat.md" - }, - { - "text": "MenuItemLocation", - "link": "/en-US/dev/joplin-plugin-api/enumerations/MenuItemLocation.md" - }, - { - "text": "ModelType", - "link": "/en-US/dev/joplin-plugin-api/enumerations/ModelType.md" - }, - { - "text": "SettingItemSubType", - "link": "/en-US/dev/joplin-plugin-api/enumerations/SettingItemSubType.md" - }, - { - "text": "SettingItemType", - "link": "/en-US/dev/joplin-plugin-api/enumerations/SettingItemType.md" - }, - { - "text": "SettingStorage", - "link": "/en-US/dev/joplin-plugin-api/enumerations/SettingStorage.md" - }, - { - "text": "ToolbarButtonLocation", - "link": "/en-US/dev/joplin-plugin-api/enumerations/ToolbarButtonLocation.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "ButtonSpec", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ButtonSpec.md" - }, - { - "text": "CodeMirrorContentScriptModule", - "link": "/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorContentScriptModule.md" - }, - { - "text": "CodeMirrorControl", - "link": "/en-US/dev/joplin-plugin-api/interfaces/CodeMirrorControl.md" - }, - { - "text": "Command", - "link": "/en-US/dev/joplin-plugin-api/interfaces/Command.md" - }, - { - "text": "ContentScriptContext", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ContentScriptContext.md" - }, - { - "text": "ContentScriptModule", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModule.md" - }, - { - "text": "ContentScriptModuleLoadedEvent", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ContentScriptModuleLoadedEvent.md" - }, - { - "text": "CreateMenuItemOptions", - "link": "/en-US/dev/joplin-plugin-api/interfaces/CreateMenuItemOptions.md" - }, - { - "text": "DialogResult", - "link": "/en-US/dev/joplin-plugin-api/interfaces/DialogResult.md" - }, - { - "text": "Disposable", - "link": "/en-US/dev/joplin-plugin-api/interfaces/Disposable.md" - }, - { - "text": "EditorCommand", - "link": "/en-US/dev/joplin-plugin-api/interfaces/EditorCommand.md" - }, - { - "text": "ExportContext", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ExportContext.md" - }, - { - "text": "ExportModule", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ExportModule.md" - }, - { - "text": "ExportOptions", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ExportOptions.md" - }, - { - "text": "ImportContext", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ImportContext.md" - }, - { - "text": "ImportModule", - "link": "/en-US/dev/joplin-plugin-api/interfaces/ImportModule.md" - }, - { - "text": "MarkdownItContentScriptModule", - "link": "/en-US/dev/joplin-plugin-api/interfaces/MarkdownItContentScriptModule.md" - }, - { - "text": "MenuItem", - "link": "/en-US/dev/joplin-plugin-api/interfaces/MenuItem.md" - }, - { - "text": "Rectangle", - "link": "/en-US/dev/joplin-plugin-api/interfaces/Rectangle.md" - }, - { - "text": "Script", - "link": "/en-US/dev/joplin-plugin-api/interfaces/Script.md" - }, - { - "text": "SettingItem", - "link": "/en-US/dev/joplin-plugin-api/interfaces/SettingItem.md" - }, - { - "text": "SettingSection", - "link": "/en-US/dev/joplin-plugin-api/interfaces/SettingSection.md" - }, - { - "text": "Size", - "link": "/en-US/dev/joplin-plugin-api/interfaces/Size.md" - }, - { - "text": "VersionInfo", - "link": "/en-US/dev/joplin-plugin-api/interfaces/VersionInfo.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "ButtonId", - "link": "/en-US/dev/joplin-plugin-api/type-aliases/ButtonId.md" - }, - { - "text": "Path", - "link": "/en-US/dev/joplin-plugin-api/type-aliases/Path.md" - }, - { - "text": "PostMessageHandler", - "link": "/en-US/dev/joplin-plugin-api/type-aliases/PostMessageHandler.md" - }, - { - "text": "ViewHandle", - "link": "/en-US/dev/joplin-plugin-api/type-aliases/ViewHandle.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "default", - "link": "/en-US/dev/joplin-plugin-api/variables/default.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "isContextMenuItemLocation", - "link": "/en-US/dev/joplin-plugin-api/functions/isContextMenuItemLocation.md" - } - ] - } - ] - }, - { - "text": "jpl-vite", - "link": "/en-US/dev/jpl-vite/", - "collapsed": true, - "items": [ - { - "text": "api", - "link": "/en-US/dev/jpl-vite/api/", - "collapsed": true, - "items": [ - { - "text": "Enumerations", - "collapsed": true, - "items": [ - { - "text": "AppType", - "link": "/en-US/dev/jpl-vite/api/enumerations/AppType.md" - }, - { - "text": "ContentScriptType", - "link": "/en-US/dev/jpl-vite/api/enumerations/ContentScriptType.md" - }, - { - "text": "FileSystemItem", - "link": "/en-US/dev/jpl-vite/api/enumerations/FileSystemItem.md" - }, - { - "text": "ImportModuleOutputFormat", - "link": "/en-US/dev/jpl-vite/api/enumerations/ImportModuleOutputFormat.md" - }, - { - "text": "MenuItemLocation", - "link": "/en-US/dev/jpl-vite/api/enumerations/MenuItemLocation.md" - }, - { - "text": "ModelType", - "link": "/en-US/dev/jpl-vite/api/enumerations/ModelType.md" - }, - { - "text": "SettingItemSubType", - "link": "/en-US/dev/jpl-vite/api/enumerations/SettingItemSubType.md" - }, - { - "text": "SettingItemType", - "link": "/en-US/dev/jpl-vite/api/enumerations/SettingItemType.md" - }, - { - "text": "SettingStorage", - "link": "/en-US/dev/jpl-vite/api/enumerations/SettingStorage.md" - }, - { - "text": "ToolbarButtonLocation", - "link": "/en-US/dev/jpl-vite/api/enumerations/ToolbarButtonLocation.md" - } - ] - }, - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "ButtonSpec", - "link": "/en-US/dev/jpl-vite/api/interfaces/ButtonSpec.md" - }, - { - "text": "CodeMirrorContentScriptModule", - "link": "/en-US/dev/jpl-vite/api/interfaces/CodeMirrorContentScriptModule.md" - }, - { - "text": "CodeMirrorControl", - "link": "/en-US/dev/jpl-vite/api/interfaces/CodeMirrorControl.md" - }, - { - "text": "Command", - "link": "/en-US/dev/jpl-vite/api/interfaces/Command.md" - }, - { - "text": "ContentScriptContext", - "link": "/en-US/dev/jpl-vite/api/interfaces/ContentScriptContext.md" - }, - { - "text": "ContentScriptModule", - "link": "/en-US/dev/jpl-vite/api/interfaces/ContentScriptModule.md" - }, - { - "text": "ContentScriptModuleLoadedEvent", - "link": "/en-US/dev/jpl-vite/api/interfaces/ContentScriptModuleLoadedEvent.md" - }, - { - "text": "CreateMenuItemOptions", - "link": "/en-US/dev/jpl-vite/api/interfaces/CreateMenuItemOptions.md" - }, - { - "text": "DialogResult", - "link": "/en-US/dev/jpl-vite/api/interfaces/DialogResult.md" - }, - { - "text": "Disposable", - "link": "/en-US/dev/jpl-vite/api/interfaces/Disposable.md" - }, - { - "text": "EditorCommand", - "link": "/en-US/dev/jpl-vite/api/interfaces/EditorCommand.md" - }, - { - "text": "ExportContext", - "link": "/en-US/dev/jpl-vite/api/interfaces/ExportContext.md" - }, - { - "text": "ExportModule", - "link": "/en-US/dev/jpl-vite/api/interfaces/ExportModule.md" - }, - { - "text": "ExportOptions", - "link": "/en-US/dev/jpl-vite/api/interfaces/ExportOptions.md" - }, - { - "text": "ImportContext", - "link": "/en-US/dev/jpl-vite/api/interfaces/ImportContext.md" - }, - { - "text": "ImportModule", - "link": "/en-US/dev/jpl-vite/api/interfaces/ImportModule.md" - }, - { - "text": "MarkdownItContentScriptModule", - "link": "/en-US/dev/jpl-vite/api/interfaces/MarkdownItContentScriptModule.md" - }, - { - "text": "MenuItem", - "link": "/en-US/dev/jpl-vite/api/interfaces/MenuItem.md" - }, - { - "text": "Rectangle", - "link": "/en-US/dev/jpl-vite/api/interfaces/Rectangle.md" - }, - { - "text": "Script", - "link": "/en-US/dev/jpl-vite/api/interfaces/Script.md" - }, - { - "text": "SettingItem", - "link": "/en-US/dev/jpl-vite/api/interfaces/SettingItem.md" - }, - { - "text": "SettingSection", - "link": "/en-US/dev/jpl-vite/api/interfaces/SettingSection.md" - }, - { - "text": "Size", - "link": "/en-US/dev/jpl-vite/api/interfaces/Size.md" - }, - { - "text": "VersionInfo", - "link": "/en-US/dev/jpl-vite/api/interfaces/VersionInfo.md" - } - ] - }, - { - "text": "Type Aliases", - "collapsed": true, - "items": [ - { - "text": "ButtonId", - "link": "/en-US/dev/jpl-vite/api/type-aliases/ButtonId.md" - }, - { - "text": "Path", - "link": "/en-US/dev/jpl-vite/api/type-aliases/Path.md" - }, - { - "text": "PostMessageHandler", - "link": "/en-US/dev/jpl-vite/api/type-aliases/PostMessageHandler.md" - }, - { - "text": "ViewHandle", - "link": "/en-US/dev/jpl-vite/api/type-aliases/ViewHandle.md" - } - ] - }, - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "joplin", - "link": "/en-US/dev/jpl-vite/api/variables/joplin.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "isContextMenuItemLocation", - "link": "/en-US/dev/jpl-vite/api/functions/isContextMenuItemLocation.md" - } - ] - } - ] - }, - { - "text": "index", - "link": "/en-US/dev/jpl-vite/index/", - "collapsed": true, - "items": [ - { - "text": "Interfaces", - "collapsed": true, - "items": [ - { - "text": "PluginConfig", - "link": "/en-US/dev/jpl-vite/index/interfaces/PluginConfig.md" - }, - { - "text": "ResolvedPluginConfig", - "link": "/en-US/dev/jpl-vite/index/interfaces/ResolvedPluginConfig.md" - } - ] - }, - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "defineConfig", - "link": "/en-US/dev/jpl-vite/index/functions/defineConfig.md" - }, - { - "text": "getEnv", - "link": "/en-US/dev/jpl-vite/index/functions/getEnv.md" - } - ] - } - ] - }, - { - "text": "messaging", - "link": "/en-US/dev/jpl-vite/messaging/", - "collapsed": true, - "items": [ - { - "text": "Functions", - "collapsed": true, - "items": [ - { - "text": "defineExtensionMessaging", - "link": "/en-US/dev/jpl-vite/messaging/functions/defineExtensionMessaging.md" - } - ] - } - ] - }, - { - "text": "webview", - "link": "/en-US/dev/jpl-vite/webview/", - "collapsed": true, - "items": [ - { - "text": "Variables", - "collapsed": true, - "items": [ - { - "text": "webviewApi", - "link": "/en-US/dev/jpl-vite/webview/variables/webviewApi.md" - } - ] - } - ] - } - ] - } -]