All files / core/src/types ImageLoaderFn.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17                                 
/**
 * 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.
 */
type ImageLoaderFn = (
  imageId: string,
  options?: Record<string, unknown>
) => {
  /** Promise that resolves to the image object */
  promise: Promise<Record<string, unknown>>;
  cancelFn?: () => void | undefined;
  decache?: () => void | undefined;
};
 
export type { ImageLoaderFn as default };