Package io.github.cdklabs.projen.javascript

Class TypescriptConfig.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.TypescriptConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TypescriptConfig>

Enclosing class:

TypescriptConfig

@Stability(Experimental)
public static final class TypescriptConfig.Builder
extends Object
implements software.amazon.jsii.Builder<TypescriptConfig>

(experimental) A fluent builder for TypescriptConfig.

Method Summary

Modifier and Type	Method	Description
TypescriptConfig	build()
TypescriptConfig.Builder	compilerOptions(TypeScriptCompilerOptions compilerOptions)	(experimental) Compiler options to use.
static TypescriptConfig.Builder	create(Project project)
TypescriptConfig.Builder	exclude(List<String> exclude)	(experimental) Filters results from the "include" option.
TypescriptConfig.Builder	extendsValue(TypescriptConfigExtends extendsValue)	(experimental) Base tsconfig.json configuration(s) to inherit from.
TypescriptConfig.Builder	fileName(String fileName)	Default: "tsconfig.json"
TypescriptConfig.Builder	include(List<String> include)	(experimental) Specifies a list of glob patterns that match TypeScript files to be included in compilation.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static TypescriptConfig.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of TypescriptConfig.Builder.

compilerOptions

@Stability(Experimental)
public TypescriptConfig.Builder compilerOptions(TypeScriptCompilerOptions compilerOptions)

(experimental) Compiler options to use.

Parameters:

compilerOptions - Compiler options to use. This parameter is required.

Returns:

this

exclude

@Stability(Experimental)
public TypescriptConfig.Builder exclude(List<String> exclude)

(experimental) Filters results from the "include" option.

Default: - node_modules is excluded by default

Parameters:

exclude - Filters results from the "include" option. This parameter is required.

Returns:

this

extendsValue

@Stability(Experimental)
public TypescriptConfig.Builder extendsValue(TypescriptConfigExtends extendsValue)

(experimental) Base tsconfig.json configuration(s) to inherit from.

Parameters:

extendsValue - Base tsconfig.json configuration(s) to inherit from. This parameter is required.

Returns:

this

fileName

@Stability(Experimental)
public TypescriptConfig.Builder fileName(String fileName)

Default: "tsconfig.json"

Parameters:

fileName - This parameter is required.

Returns:

this

include

@Stability(Experimental)
public TypescriptConfig.Builder include(List<String> include)

(experimental) Specifies a list of glob patterns that match TypeScript files to be included in compilation.

Default: - all .ts files recursively

Parameters:

include - Specifies a list of glob patterns that match TypeScript files to be included in compilation. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public TypescriptConfig build()

Specified by:

build in interface software.amazon.jsii.Builder<TypescriptConfig>

Returns:

a newly built instance of TypescriptConfig.