Class Dockerfile

Represents a Dockerfile that can be synthesized into a file on the filesystem.

Hierarchy

Dockerfile

Index

Constructors

Properties

buildStages dockerfileDirectory dockerfileName

Methods

directory instructions name path stages synthesize newBuilder

Constructors

`Private` constructor

new Dockerfile(dockerfileName, dockerfileDirectory, buildStages): Dockerfile
Parameters
- dockerfileName: string
- dockerfileDirectory: string
- buildStages: readonly BuildStage[]
Returns Dockerfile
- Defined in Dockerfile.ts:29

Properties

`Private` `Readonly` buildStages

buildStages: readonly BuildStage[]

The build stages.

`Private` `Readonly` dockerfileDirectory

dockerfileDirectory: string

The directory name for the generated Dockerfile.

`Private` `Readonly` dockerfileName

dockerfileName: string

The Dockerfile name to generate.

Methods

directory

directory(): string
Returns the Dockerfile directory.

Returns string
- Defined in Dockerfile.ts:81

`Private` instructions

instructions(): readonly DockerfileInstruction[]
Returns all instructions from all build stages.

Returns readonly DockerfileInstruction[]
- Defined in Dockerfile.ts:110

name

name(): string
Returns the Dockerfile name.

Returns string
- Defined in Dockerfile.ts:76

path

path(): string
Returns the Dockerfile path.

Returns string
- Defined in Dockerfile.ts:86

stages

stages(): readonly BuildStage[]
Internal
Returns the Dockerfile build stages.

Returns readonly BuildStage[]
- Defined in Dockerfile.ts:95

synthesize

synthesize(): void
Synthesizes a Dockerfile to the filesystem.

Returns void
- Defined in Dockerfile.ts:100

`Static` newBuilder

newBuilder(): DockerfileBuilder
Returns a new instance of the DockerfileBuilder.

Returns DockerfileBuilder
- Defined in Dockerfile.ts:36

Generated using TypeDoc