Documentation - v0.0.0
    Preparing search index...

    Managed TypeScriptSourceFile through TypeScript AST

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    absolutePath: string

    The absolute path of this file.

    executable: boolean

    Indicates if the file should be marked as executable

    filePath: string
    node: Node

    The tree node.

    path: string

    The file path, relative to the project's outdir.

    project: TypeScriptProject
    readonly: boolean

    Indicates if the file should be read-only or read-write.

    tsconfigFile: ObjectFile

    Accessors

    • get changed(): boolean | undefined

      Indicates if the file has been changed during synthesis. This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

      Returns boolean | undefined

    • get marker(): string | undefined

      The projen marker, used to identify files as projen-generated.

      Value is undefined if the project is being ejected.

      Returns string | undefined

    Methods

    • Find default export expression of SyntaxKind type.

      Type Parameters

      • T extends SyntaxKind

      Parameters

      • source: SourceFile

        SourceFile to look at.

      • expressionKind: T

        SyntaxKind of export expression.

      Returns KindToExpressionMappings[T]

    • Get or create property assignment initializer on object literal.

      Type Parameters

      • T extends SyntaxKind

      Parameters

      • objectLiteral: ObjectLiteralExpression

        Source ObjectLiteralExpression

      • name: string

        Property assignment name.

      • initializerKind: T

        SyntaxKind of initializer.

      • OptionaldefaultInitializer: string | WriterFunction

        Specify initializer to use if creation is warranted. Default depends on initializerKind.

      Returns KindToExpressionMappings[T]

    • Called after synthesis. Order is not guaranteed.

      Returns void

    • Called before synthesis.

      Returns void

    • Writes the file to the project's output directory

      Returns void

    • Returns a string representation of this construct.

      Returns string

    • Applies one or more mixins to this construct.

      Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

      Parameters

      • ...mixins: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

    • Test whether the given construct is a component.

      Parameters

      • x: any

      Returns x is Component

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.