Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Insert an image into the current layer of the current note page.
pngPath must point to an existing, readable image file, and only png, jpg, and jpeg formats are supported.static insertImage(pngPath: string): Promise<APIResponse<boolean>>;
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pngPath | string | Yes | - | Image file path (must exist and be readable, and only png, jpg, and jpeg formats are supported) |
APIResponse<boolean>:
success === true, result is true/false indicating whether insertion succeededsuccess === false, see error.code / error.messageimport { PluginNoteAPI } from 'sn-plugin-lib';
/**
* Example: insert an image into the current note page.
*/
export async function exampleInsertImage() {
const pngPath = '/storage/emulated/0/Note/demo.png';
const res = await PluginNoteAPI.insertImage(pngPath);
if (!res.success) {
throw new Error(res.error?.message ?? 'insertImage call failed');
}
return res.result;
}