Package io.github.cdklabs.projen.javascript

Class TypescriptConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.javascript.TypescriptConfig

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.213Z")
@Stability(Experimental)
public class TypescriptConfig
extends Component

Nested Class Summary

Nested Classes

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

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, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addExclude(String pattern)
void	addExtends(TypescriptConfig value)	(experimental) Extend from base TypescriptConfig instance.
void	addInclude(String pattern)
TypeScriptCompilerOptions	getCompilerOptions()
List<String>	getExclude()
List<String>	getExtendsValue()	(experimental) Array of base tsconfig.json paths.
JsonFile	getFile()
String	getFileName()
List<String>	getInclude()
void	preSynthesize()	(experimental) Called before synthesis.
String	resolveExtendsPath(String configPath)	(experimental) Resolve valid TypeScript extends paths relative to this config.

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

TypescriptConfig

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

TypescriptConfig

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

TypescriptConfig

@Stability(Experimental)
public TypescriptConfig(@NotNull
                        Project project,
                        @NotNull
                        TypescriptConfigOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addExclude

@Stability(Experimental)
public void addExclude(@NotNull
                       String pattern)

Parameters:

pattern - This parameter is required.

addExtends

@Stability(Experimental)
public void addExtends(@NotNull
                       TypescriptConfig value)

(experimental) Extend from base TypescriptConfig instance.

Parameters:

value - Base TypescriptConfig instance. This parameter is required.

addInclude

@Stability(Experimental)
public void addInclude(@NotNull
                       String pattern)

Parameters:

pattern - This parameter is required.

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

resolveExtendsPath

@Stability(Experimental)
@NotNull
public String resolveExtendsPath(@NotNull
                                 String configPath)

(experimental) Resolve valid TypeScript extends paths relative to this config.

Parameters:

configPath - Path to resolve against. This parameter is required.

getExclude

@Stability(Experimental)
@NotNull
public List<String> getExclude()

getExtendsValue

@Stability(Experimental)
@NotNull
public List<String> getExtendsValue()

(experimental) Array of base tsconfig.json paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is.

getFile

@Stability(Experimental)
@NotNull
public JsonFile getFile()

getFileName

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

getInclude

@Stability(Experimental)
@NotNull
public List<String> getInclude()

getCompilerOptions

@Stability(Experimental)
@Nullable
public TypeScriptCompilerOptions getCompilerOptions()