Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Actions

Index

Methods

containerObject

  • containerObject(docker: Dockerode, containerName: string): Container

createInstance

createNetwork

  • createNetwork(dockerode: Dockerode, config: ContainerCreateOptions): Promise<void>
  • Creates a network

    memberof

    Actions

    Parameters

    • dockerode: Dockerode

      Instance Dockerode

    • config: ContainerCreateOptions

      Container create options

    Returns Promise<void>

createNewContaier

  • createNewContaier(docker: Dockerode, config: ContainerCreateOptions): Promise<Container>
  • Create a new container

    memberof

    Actions

    Parameters

    • docker: Dockerode

      Dockerode Instance

    • config: ContainerCreateOptions

      Container create options

    Returns Promise<Container>

hasContainer

  • hasContainer(actions: Actions, dockerode: Dockerode, container: Container, infoContainer: ContainerInspectInfo, config: ContainerCreateOptions): Promise<string[]>
  • Way there is a container

    memberof

    Actions

    Parameters

    • actions: Actions

      Self Instance

    • dockerode: Dockerode

      Instance Dockerode

    • container: Container

      Object Container

    • infoContainer: ContainerInspectInfo

      Object Container Inspect Info

    • config: ContainerCreateOptions

      Container create options

    Returns Promise<string[]>

inspectContainer

  • inspectContainer(container: Container): Promise<ContainerInspectInfo | string>
  • memberof

    Actions

    Parameters

    • container: Container

      Container to inspect

    Returns Promise<ContainerInspectInfo | string>

noSuchContainer

  • noSuchContainer(actions: Actions, dockerode: Dockerode, config: ContainerCreateOptions): Promise<void | string[]>
  • Way there is no container

    memberof

    Actions

    Parameters

    • actions: Actions

      Self Instance

    • dockerode: Dockerode

      Instance Dockerode

    • config: ContainerCreateOptions

      Container create options

    Returns Promise<void | string[]>

pullImage

  • pullImage(docker: Dockerode, imageName: string): Promise<Image>

removeImage

  • removeImage(docker: Dockerode, imageName: string): Promise<string[]>

startContainer

  • startContainer(newContainer: Container): Promise<void>
  • Starts a container

    memberof

    Actions

    Parameters

    • newContainer: Container

      Newly created container

    Returns Promise<void>

startDeployRoutine

stopAndRemoveContainer

  • stopAndRemoveContainer(container: Container): Promise<string[]>
  • Stop and Remove container

    memberof

    Actions

    Parameters

    • container: Container

      Object container

    Returns Promise<string[]>

Generated using TypeDoc