Documentation - v0.0.0
    Preparing search index...

    Interface TypeScriptSourceConfigOptions<ConfigT>

    interface TypeScriptSourceConfigOptions<ConfigT = Record<string, any>> {
        committed?: boolean;
        config?: ConfigT;
        configResolver?: (
            tsConfig: TypeScriptSourceConfig,
            source: SourceFile,
        ) => ObjectLiteralExpression;
        editGitignore?: boolean;
        executable?: boolean;
        format?: boolean;
        marker?: boolean;
        pluginsProperty?: string;
        recreate?: boolean;
        source: string;
        transforms?: TypeScriptSourceFileTransform[];
        tsconfig?: ObjectFile;
    }

    Type Parameters

    • ConfigT = Record<string, any>

    Hierarchy (View Summary)

    Index

    Properties

    committed? config? configResolver? editGitignore? executable? format? marker? pluginsProperty? recreate? source transforms? tsconfig?

    Properties

    committed?: boolean

    Indicates whether this file should be committed to git or ignored. By default, all generated files are committed and anti-tamper is used to protect against manual modifications.

    true
    config?: ConfigT

    Config spec for current component.

    configResolver?: (
        tsConfig: TypeScriptSourceConfig,
        source: SourceFile,
    ) => ObjectLiteralExpression

    Resolver for config object expression.

    Type Declaration

    editGitignore?: boolean

    Update the project's .gitignore file

    true
    executable?: boolean

    Whether the generated file should be marked as executable.

    false
    format?: boolean
    marker?: boolean

    Adds the projen marker to the file.

    - marker will be included as long as the project is not ejected
    pluginsProperty?: string

    Generic plugins property name.

    recreate?: boolean
    source: string
    transforms?: TypeScriptSourceFileTransform[]
    tsconfig?: ObjectFile

    Settings

    Member Visibility

    On This Page

    Properties