Skip to content

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
cleve-fauna committed Dec 13, 2024
1 parent 140f434 commit 5790c3f
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions src/lib/docker-containers.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,9 @@ arguments --name <newName> --hostPort ${hostPort} to start the container.`,

/**
* Checks if a port is occupied.
* @param {number} hostPort The port to check
* @param {string} hostIp The IP address to bind the container's exposed port on the host.
* @param {Object} options The options object
* @param {number} options.hostPort The port to check
* @param {string} options.hostIp The IP address to bind the container's exposed port on the host.
* @returns {Promise<boolean>} a promise that resolves to true if the port is occupied, false otherwise.
*/
async function isPortOccupied({ hostPort, hostIp }) {
Expand Down Expand Up @@ -236,11 +237,12 @@ Please pass a --hostPort other than '${hostPort}'.`,

/**
* Starts a container and returns a log stream if the container is not yet running.
* @param {string} imageName The name of the image to create the container from
* @param {string} containerName The name of the container to start
* @param {string} hostIp The IP address to bind the container's exposed port on the host.
* @param {number} hostPort The port on the host machine mapped to the container's port
* @param {number} containerPort The port inside the container Fauna listens on
* @param {Object} options The options object
* @param {string} options.imageName The name of the image to create the container from
* @param {string} options.containerName The name of the container to start
* @param {string} options.hostIp The IP address to bind the container's exposed port on the host.
* @param {number} options.hostPort The port on the host machine mapped to the container's port
* @param {number} options.containerPort The port inside the container Fauna listens on
* @returns {Promise<Object>} The log stream
*/
async function startContainer({
Expand Down

0 comments on commit 5790c3f

Please sign in to comment.