Class Container

Optionaloptions

mountPath

• get mountPath(): string

  Returns string

name

• get name(): string

  Returns string

commit

• commit(__namedParameters?: CommitOptions): Promise<string>

  Parameters

  • __namedParameters: CommitOptions = {}

  Returns Promise<string>

executeStep

• executeStep(step: 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: string, strictDotDot?: boolean): Promise<string>

  Parameters

  • subPath: string
  • OptionalstrictDotDot: boolean

  Returns Promise<string>

resolveParent

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

  Parameters

  • subPath: string
  • OptionalstrictDotDot: boolean

  Returns Promise<string>

run

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

  Parameters

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

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

tempFolder

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

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

toPathInContainer

• toPathInContainer(absolutePath: string): string

  Parameters

  • absolutePath: string

  Returns string

Staticfrom

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

  Parameters

  • image: string
  • Optionaloptions: ContainerOptions

  Returns Promise<Container>