DefaultAssetServerOptions

DefaultAssetServerOptions

Documentation generated from default-asset-server-plugin.ts on Feb 19 2019 at 16:20

The configuration options for the DefaultAssetServerPlugin.

Signature

interface DefaultAssetServerOptions {
  hostname?: string;
  port: number;
  route: string;
  assetUploadDir: string;
  previewMaxWidth?: number;
  previewMaxHeight?: number;
  presets?: ImageTransformPreset[];
}

Members

hostname

property
type:
string

port

property
type:
number

The local port that the server will run on. Note that the DefaultAssetServerPlugin includes a proxy server which allows the asset server to be accessed on the same port as the main Vendure server.

route

property
type:
string

The proxy route to the asset server.

assetUploadDir

property
type:
string

The local directory to which assets will be uploaded.

previewMaxWidth

property
type:
number
default:
1600

The max width in pixels of a generated preview image.

previewMaxHeight

property
type:
number
default:
1600

The max height in pixels of a generated preview image.

presets

property

An array of additional ImageTransformPreset objects.

alpha