From 13feb30f3ff9b913670a5fe7c8a9c1907d2c1740 Mon Sep 17 00:00:00 2001 From: Mark Powers Date: Fri, 4 Jul 2025 12:03:11 -0500 Subject: Initial commit --- api/JoplinInterop.d.ts | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 api/JoplinInterop.d.ts (limited to 'api/JoplinInterop.d.ts') diff --git a/api/JoplinInterop.d.ts b/api/JoplinInterop.d.ts new file mode 100644 index 0000000..349edd2 --- /dev/null +++ b/api/JoplinInterop.d.ts @@ -0,0 +1,20 @@ +import { ExportModule, ImportModule } from './types'; +/** + * Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format. + * + * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/json_export) + * + * To implement an import or export module, you would simply define an object with various event handlers that are called + * by the application during the import/export process. + * + * See the documentation of the [[ExportModule]] and [[ImportModule]] for more information. + * + * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/help/api/references/rest_api + * + * desktop: While it is possible to register import and export + * modules on mobile, there is no GUI to activate them. + */ +export default class JoplinInterop { + registerExportModule(module: ExportModule): Promise; + registerImportModule(module: ImportModule): Promise; +} -- cgit v1.2.3