Src Docker

Docker

The docker dicretory contains everything related to docker.

Files

All of the files in the Docker folder.

DockerCompose.ts

DockerCompose.ts contains the following.

Function : DockerCompose(dir: string)

Paremeters

• dir : Expects a string which should be the location where our docker-compose.yml is located at.

Returns: Promise<String>
Description: This function runs docker-compose up -d on a docker-compose.yml file.

Function : CreateDockerCompose(options: ICreateDockerCompose)

Paremeters

• options : Expects ICreateDockerCompose coming soon.

Returns: String
Description: This functions creates a docker-compose.yml string which can be used to create the file.

---

DockerDown.ts

DockerDown.ts contains the following.

Function : DockerRemove(dir: string)

Paremeters

• dir : Expects a directory where the docker-compose.yml file is located at

Returns: Boolean
Description: This functions removes the container and it volumes.

---

Pull.ts

Pull.ts contains the following.

Function : PullImage(dir: string)

Paremeters

• dir : The location where docker-compose.yml is located at.

Returns: Boolean
Description: This functions pulls the image of the service the docker-compose.yml contains.