Class Builder

Hierarchy

Builder

Constructors

constructor

new Builder(pod: Pod): Builder

- Defined in packages/amagaki/src/builder.ts:94
Parameters
- pod: Pod
Returns Builder

Properties

benchmarkPodPath

benchmarkPodPath: string

controlDirectoryAbsolutePath

controlDirectoryAbsolutePath: string

Private date

date: Date

When the builder was initialized.

manifestPath

manifestPath: string

metricsPodPath

metricsPodPath: string

missingTranslationsPodPath

missingTranslationsPodPath: string

outputDirectoryPodPath

outputDirectoryPodPath: string

pod

pod: Pod

Static DefaultOutputDirectory

DefaultOutputDirectory: string = 'build'

Static NumConcurrentBuilds

NumConcurrentBuilds: number = 40

Static NumConcurrentCopies

NumConcurrentCopies: number = 2000

Static ShowMoveProgressBarThreshold

ShowMoveProgressBarThreshold: number = 1000

Methods

build

build(options?: BuildOptions): Promise<BuildResult>

- Defined in packages/amagaki/src/builder.ts:416
Parameters
- Optional options: BuildOptions
Returns Promise<BuildResult>

cleanOutputUsingManifests

cleanOutputUsingManifests(existingManifest: BuildManifest, newManifest: BuildManifest, options?: BuildOptions): BuildDiffPaths

- Defined in packages/amagaki/src/builder.ts:234
Parameters
- existingManifest: BuildManifest
- newManifest: BuildManifest
- Optional options: BuildOptions
Returns BuildDiffPaths

copyFileAsync

copyFileAsync(outputPath: string, podPath: string): Promise<void>

- Defined in packages/amagaki/src/builder.ts:155
Parameters
- outputPath: string
- podPath: string
Returns Promise<void>

deleteDirectoryRecursive

deleteDirectoryRecursive(path: string): void

- Defined in packages/amagaki/src/builder.ts:184
Parameters
- path: string
Returns void

deleteOutputFiles

deleteOutputFiles(paths: string[], outputRootDir: string): void

- Defined in packages/amagaki/src/builder.ts:201
Parameters
- paths: string[]
- outputRootDir: string
Returns void

export

export(options: ExportOptions): Promise<BuildDiffPaths>

- Defined in packages/amagaki/src/builder.ts:298
Parameters
- options: ExportOptions
Returns Promise<BuildDiffPaths>

exportBenchmark

exportBenchmark(): Promise<void>

- Defined in packages/amagaki/src/builder.ts:752
Returns Promise<void>

getFileSha

getFileSha(outputPath: string): Promise<any>

- Defined in packages/amagaki/src/builder.ts:128
Parameters
- outputPath: string
Returns Promise<any>

getManifest

getManifest(filePath: string): BuildManifest

- Defined in packages/amagaki/src/builder.ts:228
Parameters
- filePath: string
Returns BuildManifest

logResult

logResult(buildDiff: BuildDiffPaths, buildMetrics: BuildMetrics, options?: BuildOptions): void

- Defined in packages/amagaki/src/builder.ts:677
Parameters
- buildDiff: BuildDiffPaths
- buildMetrics: BuildMetrics
- Optional options: BuildOptions
Returns void

moveFileAsync

moveFileAsync(beforePath: string, afterPath: string): Promise<void>

- Defined in packages/amagaki/src/builder.ts:163
Parameters
- beforePath: string
- afterPath: string
Returns Promise<void>

writeFileAsync

writeFileAsync(outputPath: string, content: string): Promise<void>

- Defined in packages/amagaki/src/builder.ts:179
Parameters
- outputPath: string
- content: string
Returns Promise<void>

writeLocales

writeLocales(localesToMissingTranslations: LocalesToMissingTranslations): Promise<void>

- Defined in packages/amagaki/src/builder.ts:729
Parameters
- localesToMissingTranslations: LocalesToMissingTranslations
Returns Promise<void>

Static createProgressBar

createProgressBar(label: string): SingleBar

- Defined in packages/amagaki/src/builder.ts:284
Parameters
- label: string
Returns SingleBar

Static ensureDirectoryExists

ensureDirectoryExists(path: string): void

- Defined in packages/amagaki/src/builder.ts:136
Parameters
- path: string
Returns void

Static formatProgressBarTime

formatProgressBarTime(t: number): string

- Defined in packages/amagaki/src/builder.ts:143
Parameters
- t: number
Returns string

Static normalizePath

normalizePath(path: string): string

- Defined in packages/amagaki/src/builder.ts:121
Parameters
- path: string
Returns string

Generated using TypeDoc