Skip to main content

Type Alias: ImageLoaderFn()

ImageLoaderFn: (imageId, options?) => object

Any imageLoader function should implement a loading given the imageId and returns a mandatory promise which will resolve to the loaded image object. Additional cancelFn and decache can be implemented.

Parameters​

• imageId: string

• options?: Record<string, unknown>

Returns​

object

cancelFn()?​

optional cancelFn: () => void | undefined

Returns​

void | undefined

decache()?​

optional decache: () => void | undefined

Returns​

void | undefined

promise​

promise: Promise<Record<string, unknown>>

Promise that resolves to the image object

Defined in​

packages/core/src/types/ImageLoaderFn.ts:6