interface AssetServerOptions {
  route: string;
  assetUploadDir: string;
  assetUrlPrefix?: string | ((ctx: RequestContext, identifier: string) => string);
  previewMaxWidth?: number;
  previewMaxHeight?: number;
  presets?: ImageTransformPreset[];
  namingStrategy?: AssetNamingStrategy;
  storageStrategyFactory?: (
        options: AssetServerOptions,
    ) => AssetStorageStrategy | Promise<AssetStorageStrategy>;
}

The route to the asset server.

The local directory to which assets will be uploaded when using the LocalAssetStorageStrategy.

The complete URL prefix of the asset files. For example, “https://demo.vendure.io/assets/". A function can also be provided to handle more complex cases, such as serving multiple domains from a single server. In this case, the function should return a string url prefix.

If not provided, the plugin will attempt to guess based off the incoming request and the configured route. However, in all but the simplest cases, this guess may not yield correct results.

The max width in pixels of a generated preview image.

The max height in pixels of a generated preview image.

An array of additional ImageTransformPreset objects.

Defines how asset files and preview images are named before being saved.

A function which can be used to configure an AssetStorageStrategy. This is useful e.g. if you wish to store your assets using a cloud storage provider. By default, the LocalAssetStorageStrategy is used.