Interface WhiteboardThumbnailContext<TFile>

Context passed to whiteboardThumbnailGenerator's generate.

interface WhiteboardThumbnailContext<TFile extends WhiteboardThumbnailFile> {
    file: TFile;
    getFileUrl: (file: TFile) => Promise<string>;
    maxDimension: number;
    signal?: AbortSignal;
}

Type Parameters

TFile extends WhiteboardThumbnailFile

Index

Properties

file getFileUrl maxDimension signal?

Properties

file

file: TFile

The whiteboard file needing a thumbnail.

getFileUrl

getFileUrl: (file: TFile) => Promise<string>

Resolve a fetch-able URL (e.g. presigned URL) for the file.

maxDimension

maxDimension: number

Longest edge of the resulting thumbnail, in pixels.

`Optional`signal

signal?: AbortSignal

Aborts the work when the requesting card goes away (e.g. filter switch).