Package io.github.cdklabs.projen.typescript

Class ProjenrcTs

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.ProjenrcFile

io.github.cdklabs.projen.typescript.ProjenrcTs

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.271Z")
@Stability(Experimental)
public class ProjenrcTs
extends ProjenrcFile

(experimental) A projenrc file written in TypeScript.

This component can be instantiated in any type of project and has no expectations around the project's main language.

Requires that npx is available.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjenrcTs.Builder	(experimental) A fluent builder for ProjenrcTs.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	ProjenrcTs(Project project)
	ProjenrcTs(Project project, ProjenrcTsOptions options)
protected	ProjenrcTs(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProjenrcTs(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getFilePath()	(experimental) The path of the projenrc file.
TypescriptConfig	getTsconfig()	(experimental) TypeScript configuration file used to compile projen source files.
void	preSynthesize()	(experimental) Called before synthesis.

Methods inherited from class io.github.cdklabs.projen.ProjenrcFile

of

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ProjenrcTs

protected ProjenrcTs(software.amazon.jsii.JsiiObjectRef objRef)

ProjenrcTs

protected ProjenrcTs(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ProjenrcTs

@Stability(Experimental)
public ProjenrcTs(@NotNull
                  Project project,
                  @Nullable
                  ProjenrcTsOptions options)

Parameters:

project - This parameter is required.

options -

ProjenrcTs

@Stability(Experimental)
public ProjenrcTs(@NotNull
                  Project project)

Parameters:

project - This parameter is required.

Method Detail

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class ProjenrcFile

getFilePath

@Stability(Experimental)
@NotNull
public String getFilePath()

(experimental) The path of the projenrc file.

Specified by:

getFilePath in class ProjenrcFile

getTsconfig

@Stability(Experimental)
@NotNull
public TypescriptConfig getTsconfig()

(experimental) TypeScript configuration file used to compile projen source files.