Class NameSchemeBuilder

Utilize a naming scheme for a project.

Hierarchy (View Summary)

BaseBuildStep<
{ outdir?: string; packageName?: string },
{ projectName: ProjectName },
>
- NameSchemeBuilder

Index

Constructors

Properties

_output _outputOptions options?

Methods

applyOptions applyProject

Constructors

constructor

new NameSchemeBuilder(options?: ProjectNameSchemeOptions): NameSchemeBuilder
Parameters
- Optionaloptions: ProjectNameSchemeOptions
Returns NameSchemeBuilder
Overrides BaseBuildStep.constructor
- Defined in builders.ts:43

Properties

`Readonly`_output

_output: { projectName: ProjectName }

Additional project property types to merge with resulting project type.

`Readonly`_outputOptions

_outputOptions: { outdir?: string; packageName?: string }

Options type to merge with project options.

`Optional` `Readonly`options

options?: ProjectNameSchemeOptions

Methods

applyOptions

applyOptions<Options extends ProjectOptions>(
options: Options,
): Options & { outdir?: string; packageName?: string }
Apply modifications to project options prior to instantiation.
Type Parameters
- Options extends ProjectOptions
Parameters
- options: Options
  Input project options.
Returns Options & { outdir?: string; packageName?: string }
Overrides BaseBuildStep.applyOptions
- Defined in builders.ts:47

applyProject

applyProject(project: Project): TypedPropertyDescriptorMap<this["_output"]>
Apply modifications to instantiated project.
Parameters
- project: Project
  Input project.
Returns TypedPropertyDescriptorMap<this["_output"]>

Remarks
The property descriptor map returned by this method will be merged into the project.
Overrides BaseBuildStep.applyProject
- Defined in builders.ts:61