Class Build

Constructors

  • Initializes Build class with all parsed configurations

    Parameters

    • Optionalconfig: Partial<Config>

      Config Optional configuration options overrides

    Returns Build

Properties

application: { name: string; version: string } = ...

Contains detected application information

config: Config = ...

Contains currently active build configuration

Configuration is combined from:

  • Build defaults
  • Parsing optional build.json or user specified config file
  • Parsing optional tsconfig.json
  • Parsing optional eslintrc.json
  • Parsing optional typedoc.json
environment: {
    config: undefined | string;
    eslintrc: boolean;
    git: boolean;
    package: undefined | string;
    tsconfig: boolean;
} = ...

Contains detected available configuration

package: Record<string, unknown>

Contains parsed application package.json file

params: { config: string; debug: boolean; generate: boolean; profile: string } = ...

Command line params when used in Cli mode

toolchain: {
    build: string;
    esbuild: string;
    eslint: string;
    typedoc: string;
    typescript: string;
} = ...

Contains version strings of all build tools

Methods

  • Returns Promise<void>

  • Returns Promise<void>

  • Returns Promise<void>

  • Runs build pipeline for specified profile

    Parameters

    • profile: string

      Profile type, e.g. "production" or "development"

    • config: Partial<Config> = {}

      Config Optional configuration options overrides

    Returns Promise<{}>

    Object containing all messages

  • Returns Promise<string[]>

  • Parameters

    • config: any
    • options: {} = {}

    Returns any

  • Parameters

    Returns Promise<unknown>