Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DockerCompiler

Compiles a project into a Dockerfile, or Docker image

Hierarchy

  • DockerCompiler

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly urlFetcher

urlFetcher: UrlFetcher

The instance of IUrlFetcher to fetch URLs

Methods

compile

  • compile(source: string, build?: boolean, comments?: boolean, stencila?: boolean, baseImage?: undefined | string): Promise<SoftwareEnvironment | null>

  • Compile a project

    Parameters

    • source: string

      The folder, Dockerfile or SoftwareEnvironment to compile

    • Default value build: boolean = true

      Should the Docker image be built?

    • Default value comments: boolean = true

      Should comments be added to the Dockerfile?

    • Default value stencila: boolean = false

      Should relevant Stencila language packages be installed in the image?

    • Optional baseImage: undefined | string

      override the FROM parameter of the Dockerfile

    Returns Promise<SoftwareEnvironment | null>

execute

  • execute(source: string, command?: string): Promise<any>

  • Execute the project by compiling, building and running a Docker container for it

    Parameters

    • source: string

      The project to execute

    • Default value command: string = ""

    Returns Promise<any>

who

  • who(folder: string, maxDepth?: number): Promise<object>

  • Find out who contributed to the packages that your project depends upon.

    Parameters

    • folder: string

      The project to examine

    • Default value maxDepth: number = 100

      The maximum dependency recursion depth

    Returns Promise<object>

Generated using TypeDoc