Class Build

Index

Constructors

constructor

new Build(config?: Partial<Config>): Build
Initializes Build class with all parsed configurations
Parameters
- Optionalconfig: Partial<Config>
  Config Optional configuration options overrides
Returns Build
- Defined in build.ts:104

Properties

application

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

Contains detected application information

config

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

environment: {
    config: undefined | string;
    eslintrc: boolean;
    git: boolean;
    package: undefined | string;
    tsconfig: boolean;
} = ...

Contains detected available configuration

package

package: Record<string, unknown>

Contains parsed application package.json file

params

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

Command line params when used in Cli mode

toolchain

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

Contains version strings of all build tools

Methods

changelog

changelog(): Promise<void>
Returns Promise<void>
- Defined in build.ts:194

clean

clean(): Promise<void>
Returns Promise<void>
- Defined in build.ts:192

compile

compile(steps: Steps[]): Promise<void>
Parameters
- steps: Steps[]
Returns Promise<void>
- Defined in build.ts:196

lint

lint(): Promise<void>
Returns Promise<void>
- Defined in build.ts:193

packageJson

packageJson(): any
Returns any
- Defined in build.ts:145

run

run(profile: string, config?: Partial<Config>): Promise<{}>
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
- Defined in build.ts:163

serve

serve(): Promise<string[]>
Returns Promise<string[]>
- Defined in build.ts:195

typedoc

typedoc(target: Targets): Promise<void>
Parameters
- target: Targets
Returns Promise<void>
- Defined in build.ts:199

typings

typings(target: Targets): Promise<void>
Parameters
- target: Targets
Returns Promise<void>
- Defined in build.ts:198

updateConfig

updateConfig(config: any, options?: {}): any
Parameters
- config: any
- options: {} = {}
Returns any
- Defined in build.ts:125

watch

watch(steps: Steps[]): Promise<unknown>
Parameters
- steps: Steps[]
Returns Promise<unknown>
- Defined in build.ts:197

Class Build

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Build

Properties

application

config

environment

package

params

toolchain

Methods

changelog

Returns Promise<void>

clean

Returns Promise<void>

compile

Parameters

Returns Promise<void>

lint

Returns Promise<void>

packageJson

Returns any

run

Parameters

Returns Promise<{}>

serve

Returns Promise<string[]>

typedoc

Parameters

Returns Promise<void>

typings

Parameters

Returns Promise<void>

updateConfig

Parameters

Returns any

watch

Parameters

Returns Promise<unknown>

Settings

On This Page