Class ProjectBuilder<T, Options, Props>

constructor

• new ProjectBuilder<
      T extends GConstructor<any, any[]> = GenericProjectConstructor,
      Options extends object = ProjectConstructorOptions<T>,
      Props = object,
  >(
      projectConstructor: T,
      steps?: AnyBuildStep[],
  ): ProjectBuilder<T, Options, Props>

  Construct a new builder instance.

  Type Parameters

  • T extends GConstructor<any, any[]> = GenericProjectConstructor
  • Options extends object = ProjectConstructorOptions<T>
  • Props = object

  Parameters

  • projectConstructor: T

    Projen project type to wrap.

  • steps: AnyBuildStep[] = []

    Build steps to apply (in order) on build.

  Returns ProjectBuilder<T, Options, Props>

Readonly_input

Readonly_options

Readonly_props

ReadonlyprojectConstructor

Readonlysteps

add

• add<StepT extends AnyBuildStep>(
      step: StepT,
      options?: { prepend?: boolean },
  ): ProjectBuilder<
      T,
      {
          [k in string
          | number
          | symbol]: (
              Omit<Options, keyof BuildOptions<StepT>> & BuildOptions<StepT>
          )[k]
      },
      Props & BuildOutput<StepT>,
  >

  Add a build step to the builder.

  Type Parameters

  • StepT extends AnyBuildStep

  Parameters

  • step: StepT

    Build step to add.

  • options: { prepend?: boolean } = ...

    Step options.

  Returns ProjectBuilder<
      T,
      {
          [k in string
          | number
          | symbol]: (
              Omit<Options, keyof BuildOptions<StepT>> & BuildOptions<StepT>
          )[k]
      },
      Props & BuildOutput<StepT>,
  >

  A new builder instance with the added step and merged types.

  Remarks

  This will create a new builder instance and will not mutate the caller.

build

• build(options: Options): ProjectBuilderOutput<ProjectBuilder<T, Options, Props>>

  Build the project.

  Parameters

  • options: Options

    Source options to use.

  Returns ProjectBuilderOutput<ProjectBuilder<T, Options, Props>>

buildOptions

• buildOptions(options: Options): Options

  Build the final project options.

  Parameters

  • options: Options

    Source options to use.

  Returns Options