Watch Aspire live streamsDocsTry Aspire

addVolume

Method
📦 Aspire.Hosting.Docker v13.6.5
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
namestringThe name of the volume.
driverstringoptionalThe volume driver to use.
externalbooleanoptionalA value indicating whether the volume is managed outside the generated Compose file.
configure(obj: Volume) => Promise<void>optionalAn optional callback for further volume customization.
ComposeFile

Applies to

This method applies to the following types: