lumilio-web / workers/workerClient / AppWorkerClient
Class: AppWorkerClient
Defined in: workers/workerClient.ts:37
Constructors
Constructor
new AppWorkerClient(
options?):AppWorkerClient
Defined in: workers/workerClient.ts:51
Parameters
options?
WorkerClientOptions = {}
Returns
AppWorkerClient
Methods
abortExportImage()
abortExportImage():
void
Defined in: workers/workerClient.ts:554
Returns
void
abortExtractExif()
abortExtractExif():
void
Defined in: workers/workerClient.ts:597
Returns
void
abortGenerateHash()
abortGenerateHash():
void
Defined in: workers/workerClient.ts:367
Returns
void
abortGenerateThumbnail()
abortGenerateThumbnail():
void
Defined in: workers/workerClient.ts:284
Returns
void
abortStudioPlugin()
abortStudioPlugin():
void
Defined in: workers/workerClient.ts:501
Returns
void
addProgressListener()
addProgressListener(
callback): () =>void
Defined in: workers/workerClient.ts:131
Adds a progress listener that can be used by any worker task.
Parameters
callback
(detail) => void
Function to handle progress events.
Returns
A function to remove the event listener.
():
void
Returns
void
calculateJustifiedLayout()
calculateJustifiedLayout(
boxes,config):Promise<LayoutResult>
Defined in: workers/workerClient.ts:182
Parameters
boxes
LayoutBox[]
config
LayoutConfig
Returns
Promise<LayoutResult>
calculateJustifiedLayouts()
calculateJustifiedLayouts(
groups,config):Promise<Record<string,LayoutResult>>
Defined in: workers/workerClient.ts:212
Parameters
groups
Record<string, LayoutBox[]>
config
LayoutConfig
Returns
Promise<Record<string, LayoutResult>>
exportImage()
exportImage(
imageUrl,options):Promise<{blob?:Blob;error?:string;filename?:string;status:"error"|"complete"; }>
Defined in: workers/workerClient.ts:508
Parameters
imageUrl
string
options
filename?
string
format
"jpeg" | "png" | "webp" | "original"
maxHeight?
number
maxWidth?
number
quality
number
Returns
Promise<{ blob?: Blob; error?: string; filename?: string; status: "error" | "complete"; }>
extractExif()
extractExif(
files):Promise<{exifResults:object[];status:string; }>
Defined in: workers/workerClient.ts:561
Parameters
files
FileList | File[]
Returns
Promise<{ exifResults: object[]; status: string; }>
generateHash()
generateHash(
data,onItemComplete?):Promise<{status:string; }>
Defined in: workers/workerClient.ts:291
Parameters
data
FileList | File[]
onItemComplete?
(result) => void
Returns
Promise<{ status: string; }>
generateThumbnail()
generateThumbnail(
data):Promise<{batchIndex:number;results:any[];status:string; }>
Defined in: workers/workerClient.ts:243
Parameters
data
batchIndex
number
files
FileList | File[]
startIndex
number
Returns
Promise<{ batchIndex: number; results: any[]; status: string; }>
initializeJustifiedLayout()
initializeJustifiedLayout():
Promise<void>
Defined in: workers/workerClient.ts:155
Returns
Promise<void>
loadStudioPluginRunner()
loadStudioPluginRunner(
manifest):Promise<void>
Defined in: workers/workerClient.ts:372
Parameters
manifest
RuntimeManifestV1
Returns
Promise<void>
runStudioPlugin()
runStudioPlugin(
manifest,file,params):Promise<{blob:Blob;fileName:string;mimeType:string; }>
Defined in: workers/workerClient.ts:425
Parameters
manifest
RuntimeManifestV1
file
File
params
Record<string, unknown>
Returns
Promise<{ blob: Blob; fileName: string; mimeType: string; }>
terminateAllWorkers()
terminateAllWorkers():
void
Defined in: workers/workerClient.ts:608
Terminates all active workers to clean up resources. This should be called when the application is unmounting.
Returns
void