thumbkit
Version:
A comprehensive TypeScript library for generating thumbnails from images, PDFs, videos, office documents, and archives.
54 lines • 1.4 kB
TypeScript
export interface ThumbnailConfig {
width?: number;
height?: number;
quality?: number;
suffix?: string;
format?: "jpeg" | "png" | "webp" | "avif";
fit?: "cover" | "contain" | "fill" | "inside" | "outside";
withoutEnlargement?: boolean;
background?: {
r: number;
g: number;
b: number;
alpha: number;
};
position?: "top" | "right top" | "right" | "right bottom" | "bottom" | "left bottom" | "left" | "left top" | "center";
}
export interface ThumbnailResult {
fileName: string;
originalFileName: string;
fileBuffer: Buffer;
fileSizeInBytes: number;
mimeType: string;
md5Hash: string;
fileType: FileType;
dimensions: {
width: number;
height: number;
};
quality: number;
createdAt: string;
isThumbnail: boolean;
metadata?: Record<string, any>;
}
export interface BatchResult {
results: ThumbnailResult[];
errors: Array<{
index: number;
fileName?: string;
error: string;
}>;
}
export interface FileInput {
buffer: Buffer;
fileName: string;
}
export type FileType = "image" | "document" | "video" | "office" | "archive" | "unsupported";
export interface SupportedTypes {
images: string[];
documents: string[];
videos: string[];
office: string[];
archives: string[];
}
//# sourceMappingURL=index.d.ts.map