Skip to content

Documentation / joplin-plugin-api / ImportModule

Interface: ImportModule

Defined in: types.ts:131

Properties

description

description: string

Defined in: types.ts:140

The description that will appear in the UI, for example in the menu item.


fileExtensions?

optional fileExtensions: string[]

Defined in: types.ts:157

Tells the file extensions of the exported files.


format

format: string

Defined in: types.ts:135

The format to be exported, eg "enex", "jex", "json", etc.


isNoteArchive

isNoteArchive: boolean

Defined in: types.ts:147

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.


outputFormat?

optional outputFormat: ImportModuleOutputFormat

Defined in: types.ts:162

Tells the type of notes that will be generated, either HTML or Markdown (default).


sources

sources: FileSystemItem[]

Defined in: types.ts:152

The type of sources that are supported by the module. Tells whether the module can import files or directories or both.

Methods

onExec()

onExec(context): Promise<void>

Defined in: types.ts:167

Called when the import process starts. There is only one event handler within which you should import the complete data.

Parameters

context

ImportContext

Returns

Promise<void>

Released under the MIT License.