addVolume

Method

📦 Aspire.Hosting.Docker v13.4.0

interface ComposeFile {
  // ... omitted for brevity
  addVolume(
      name: string,
      driver?: string,
      external?: boolean,
      configure?: callback): ComposeFile;
}

Signature

methodaddVolume

Adds a top-level volume definition to the Docker Compose file.

addVolume(name: string, driver?: string, external?: boolean, configure?: (obj: Volume) => Promise<void>): ComposeFile

Parameters

namestring

driverstringoptional

externalbooleanoptional

configure(obj: Volume) => Promise<void>optional

Returns

ComposeFile

Applies to

This method applies to the following types:

typeComposeFile