mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-21 09:38:01 +02:00
44 lines
1.4 KiB
TypeScript
44 lines
1.4 KiB
TypeScript
|
export interface Implementation {
|
||
|
nativeImage: any;
|
||
|
}
|
||
|
export interface CreateFromBufferOptions {
|
||
|
width?: number;
|
||
|
height?: number;
|
||
|
scaleFactor?: number;
|
||
|
}
|
||
|
export interface ResizeOptions {
|
||
|
width?: number;
|
||
|
height?: number;
|
||
|
quality?: 'good' | 'better' | 'best';
|
||
|
}
|
||
|
export type Handle = string;
|
||
|
/**
|
||
|
* Provides imaging functions to resize or process images. You create an image
|
||
|
* using one of the `createFrom` functions, then use the other functions to
|
||
|
* process the image.
|
||
|
*
|
||
|
* Images are associated with a handle which is what will be available to the
|
||
|
* plugin. Once you are done with an image, free it using the `free()` function.
|
||
|
*
|
||
|
* [View the
|
||
|
* example](https://github.com/laurent22/joplin/blob/dev/packages/app-cli/tests/support/plugins/imaging/src/index.ts)
|
||
|
*
|
||
|
*/
|
||
|
export default class JoplinImaging {
|
||
|
private implementation_;
|
||
|
private images_;
|
||
|
constructor(implementation: Implementation);
|
||
|
private createImageHandle;
|
||
|
private imageByHandle;
|
||
|
private cacheImage;
|
||
|
createFromBuffer(buffer: any, options?: CreateFromBufferOptions): Promise<Handle>;
|
||
|
resize(handle: Handle, options?: ResizeOptions): Promise<string>;
|
||
|
toDataUrl(handle: Handle): Promise<string>;
|
||
|
toBase64(handle: Handle): Promise<string>;
|
||
|
/**
|
||
|
* Image data is not automatically deleted by Joplin so make sure you call
|
||
|
* this method on the handle once you are done.
|
||
|
*/
|
||
|
free(handle: Handle): Promise<void>;
|
||
|
}
|