Package io.github.cdklabs.projen.javascript

Class TypescriptConfig

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:12.160Z")
@Stability(Experimental)
public class TypescriptConfig
extends Component

    • 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)
        (experimental) Add an exclude pattern to the exclude array of the TSConfig.

        Parameters:
        pattern - The pattern to add. This parameter is required.
        See Also:
        https://www.typescriptlang.org/tsconfig#exclude

      • 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)
        (experimental) Add an include pattern to the include array of the TSConfig.

        Parameters:
        pattern - The pattern to add. This parameter is required.
        See Also:
        https://www.typescriptlang.org/tsconfig#include

      • preSynthesize

        @Stability(Experimental)
public void preSynthesize()
        (experimental) Called before synthesis.
        Overrides:
        preSynthesize in class Component

      • removeExclude

        @Stability(Experimental)
public void removeExclude​(@NotNull
                          String pattern)
        (experimental) Remove an exclude pattern from the exclude array of the TSConfig.

        Parameters:
        pattern - The pattern to remove. This parameter is required.
        See Also:
        https://www.typescriptlang.org/tsconfig#exclude

      • removeInclude

        @Stability(Experimental)
public void removeInclude​(@NotNull
                          String pattern)
        (experimental) Remove an include pattern from the include array of the TSConfig.

        Parameters:
        pattern - The pattern to remove. This parameter is required.
        See Also:
        https://www.typescriptlang.org/tsconfig#include

      • 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()