Class Add

Represents a ADD instruction.

Hierarchy

default
- Add

Implements

Committable

Index

Constructors

constructor

Methods

accept toString execForm of ofGit ofGitKeepDir withCheckSum withChown

Constructors

`Private` constructor

new Add(instructionAgruments): Add
Parameters
- instructionAgruments: string
Returns Add
Overrides AbstractInstruction.constructor
- Defined in instructions/Add.ts:17

Methods

accept

accept(writer): void
Adds the string representation of this instruction to DockerfileWriter.
Parameters
- writer: default
Returns void
Implementation of Committable.accept

Inherited from AbstractInstruction.accept
- Defined in instructions/AbstractInstruction.ts:30

toString

toString(): string
Returns the string representation for this instruction.

Returns string
Inherited from AbstractInstruction.toString
- Defined in instructions/AbstractInstruction.ts:25

`Static` `Protected` execForm

execForm(shellCommand): string
Returns exec form of shell command string.
Parameters
- shellCommand: string
Returns string
Inherited from AbstractInstruction.execForm
- Defined in instructions/AbstractInstruction.ts:36

`Static` of

of(source, destination): Add
Returns a new Add instruction of given source and destination arguments.
Parameters
- source: string
  
  the file, directory or remote file URL
- destination: string
  
  the path on the filesystem of the image
Returns Add
- Defined in instructions/Add.ts:27

`Static` ofGit

ofGit(gitReference, directory): Add
Returns a new Add instruction of given Git repository. https://docs.docker.com/engine/reference/builder/#adding-a-git-repository-add-git-ref-dir
Parameters
- gitReference: string
  
  the git repository reference
- directory: string
  
  the path on the filesystem of the image
Returns Add
- Defined in instructions/Add.ts:40

`Static` ofGitKeepDir

ofGitKeepDir(gitReference, directory): Add
Returns a new Add instruction of given git repository and add .git directory. https://docs.docker.com/engine/reference/builder/#adding-a-git-repository-add-git-ref-dir
Parameters
- gitReference: string
  
  the git repository reference
- directory: string
  
  the path on the filesystem of the image
Returns Add
- Defined in instructions/Add.ts:53

`Static` withCheckSum

withCheckSum(sourceUrl, destination, checkSum): Add
Returns a new Add instruction with verifying a remote file checksum.
Parameters
- sourceUrl: URL
  
  the remote file
- destination: string
  
  the destination into which the source will be copied
- checkSum: string
  
  the checksum of a remote file
Returns Add
- Defined in instructions/Add.ts:66

`Static` withChown

withChown(source, destination, chown, chmod?): Add
Returns a new Add instruction of given source, destination, chown arguments and optionally chmod.
Parameters
- source: string
  
  the file, directory or remote file URL
- destination: string
  
  the path on the filesystem of the image
- chown: string
  
  the username, groupname, or UID/GID to request specific ownership of the content
- Optional chmod: string
  
  the destination permissions
Returns Add
- Defined in instructions/Add.ts:81

Class Add

Hierarchy

Implements

Index

Constructors

Methods

Constructors

Private constructor

Parameters

instructionAgruments: string

Returns Add

Methods

accept

Parameters

writer: default

Returns void

toString

Returns string

Static Protected execForm

Parameters

shellCommand: string

Returns string

Static of

Parameters

source: string

destination: string

Returns Add

Static ofGit

Parameters

gitReference: string

directory: string

Returns Add

Static ofGitKeepDir

Parameters

gitReference: string

directory: string

Returns Add

Static withCheckSum

Parameters

sourceUrl: URL

destination: string

checkSum: string

Returns Add

Static withChown

Parameters

source: string

destination: string

chown: string

Optional chmod: string

Returns Add

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Static` `Protected` execForm

`Static` of

`Static` ofGit

`Static` ofGitKeepDir

`Static` withCheckSum

`Static` withChown

`Optional` chmod: string