Skip to main content

Type Alias: VolumeLoaderFn()

VolumeLoaderFn: (volumeId, options?) => object

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

Parameters​

• volumeId: string

• options?: Record<string, unknown>

Returns​

object

cancelFn()?​

optional cancelFn: () => void | undefined

cancel function

Returns​

void | undefined

decache()?​

optional decache: () => void | undefined

decache function

Returns​

void | undefined

promise​

promise: Promise<IImageVolume>

promise that resolves to the volume object

Defined in​

packages/core/src/types/VolumeLoaderFn.ts:8