Class Container

Optional options

mountPath

• get mountPath(): string

• Returns string

name

• get name(): string

• Returns string

commit

• commit(__namedParameters?): Promise<string>

• Parameters

  • __namedParameters: CommitOptions = {}

  Returns Promise<string>

executeStep

• executeStep(step): Promise<void>

• Parameters

  • step: Step

  Returns Promise<void>

mount

• mount(): Promise<string>

• Returns Promise<string>

remove

• remove(): Promise<void>

• Returns Promise<void>

resolve

• resolve(subPath, strictDotDot?): Promise<string>

• Parameters

  • subPath: string
  • Optional strictDotDot: boolean

  Returns Promise<string>

resolveParent

• resolveParent(subPath, strictDotDot?): Promise<string>

• Parameters

  • subPath: string
  • Optional strictDotDot: boolean

  Returns Promise<string>

run

• run(command, buildahOptions?): Promise<{
      stderr: Buffer;
      stdout: Buffer;
  }>

• Parameters

  • command: string[]
  • buildahOptions: string[] = []

  Returns Promise<{
      stderr: Buffer;
      stdout: Buffer;
  }>

tempFolder

• tempFolder(): Promise<{
      pathInContainer: string;
      pathInHost: string;
      remove: (() => Promise<void>);
  }>

• Returns Promise<{
      pathInContainer: string;
      pathInHost: string;
      remove: (() => Promise<void>);
  }>

toPathInContainer

• toPathInContainer(absolutePath): string

• Parameters

  • absolutePath: string

  Returns string

Static from

• from(image, options?): Promise<Container>

• Parameters

  • image: string
  • Optional options: ContainerOptions

  Returns Promise<Container>