Skip to main content

AssetOptions

AssetOptions​

@vendure/corevendure-config.ts

The AssetOptions define how assets (images and other files) are named and stored, and how preview images are generated.

Note: If you are using the AssetServerPlugin, it is not necessary to configure these options.

Signature
interface AssetOptions {
    assetNamingStrategy?: AssetNamingStrategy;
    assetStorageStrategy?: AssetStorageStrategy;
    assetPreviewStrategy?: AssetPreviewStrategy;
    permittedFileTypes?: string[];
    uploadMaxFileSize?: number;
}

assetNamingStrategy​

property
AssetNamingStrategy
default:
<a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a>

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

assetStorageStrategy​

property
AssetStorageStrategy
default:
NoAssetStorageStrategy

Defines the strategy used for storing uploaded binary files.

assetPreviewStrategy​

property
AssetPreviewStrategy
default:
NoAssetPreviewStrategy

Defines the strategy used for creating preview images of uploaded assets.

permittedFileTypes​

property
string[]
default:
image, audio, video MIME types plus PDFs

An array of the permitted file types that may be uploaded as Assets. Each entry should be in the form of a valid unique file type specifier i.e. either a file extension (".pdf") or a mime type ("image/*", "audio/mpeg" etc.).

uploadMaxFileSize​

property
number
default:
20971520

The max file size in bytes for uploaded assets.