README.md

@numbersprotocol/preview-thumbnail

The 'preview-thumbnail' plugin allows for dynamic generation of preview thumbnails from a provided URL across web, iOS, and Android platforms. This enables consistent and efficient thumbnail previews in your Capacitor applications regardless of the user's device

Install

npm install @numbersprotocol/preview-thumbnail
npx cap sync

API

• echo(...)
• thumbnailFile(...)
• thumbnailData(...)
• Interfaces
• Enums

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Param	Type
options	{ value: string; }

Returns: Promise<{ value: string; }>

---

thumbnailFile(...)

thumbnailFile(options: ThumbnailOptions) => Promise<ThumbnailFileResult>

Param	Type
options	ThumbnailOptions

Returns: Promise<ThumbnailFileResult>

---

thumbnailData(...)

thumbnailData(options: ThumbnailOptions) => Promise<ThumbnailDataResult>

Param	Type
options	ThumbnailOptions

Returns: Promise<ThumbnailDataResult>

---

Interfaces

ThumbnailFileResult

Prop	Type
value	string

ThumbnailOptions

Prop	Type
video	string
headers	{ [key: string]: string; }
thumbnailPath	string
imageFormat	ImageFormat
maxHeight	number
maxWidth	number
timeMs	number
quality	number

ThumbnailDataResult

Prop	Type
value	string

Enums

ImageFormat

Members
JPEG
PNG
WEBP