@angular/core/schematics/utils/template_ast_visitor.d.ts

Angular - the core framework

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */
/// <amd-module name="@angular/core/schematics/utils/template_ast_visitor" />
import type { TmplAstBoundAttribute, TmplAstBoundEvent, TmplAstBoundText, TmplAstContent, TmplAstElement, TmplAstIcu, TmplAstNode, TmplAstRecursiveVisitor, TmplAstReference, TmplAstTemplate, TmplAstText, TmplAstTextAttribute, TmplAstVariable } from '@angular/compiler';
/**
 * A base class that can be used to implement a Render3 Template AST visitor.
 * This class is used instead of the `NullVisitor` found within the `@angular/compiler` because
 * the `NullVisitor` requires a deep import which is no longer supported with the ESM bundled
 * packages as of v13.
 * Schematics are also currently required to be CommonJS to support execution within the Angular
 * CLI. As a result, the ESM `@angular/compiler` package must be loaded via a native dynamic import.
 * Using a dynamic import makes classes extending from classes present in `@angular/compiler`
 * complicated due to the class not being present at module evaluation time. The classes using a
 * base class found within `@angular/compiler` must be wrapped in a factory to allow the class value
 * to be accessible at runtime after the dynamic import has completed. This class implements the
 * interface of the `TmplAstRecursiveVisitor` class (but does not extend) as the
 * `TmplAstRecursiveVisitor` as an interface provides the required set of visit methods. The base
 * interface `Visitor<T>` is not exported.
 */
export declare class TemplateAstVisitor implements TmplAstRecursiveVisitor {
    protected readonly compilerModule: typeof import('@angular/compiler');
    /**
     * Creates a new Render3 Template AST visitor using an instance of the `@angular/compiler`
     * package. Passing in the compiler is required due to the need to dynamically import the
     * ESM `@angular/compiler` into a CommonJS schematic.
     *
     * @param compilerModule The compiler instance that should be used within the visitor.
     */
    constructor(compilerModule: typeof import('@angular/compiler'));
    visitElement(element: TmplAstElement): void;
    visitTemplate(template: TmplAstTemplate): void;
    visitContent(content: TmplAstContent): void;
    visitVariable(variable: TmplAstVariable): void;
    visitReference(reference: TmplAstReference): void;
    visitTextAttribute(attribute: TmplAstTextAttribute): void;
    visitBoundAttribute(attribute: TmplAstBoundAttribute): void;
    visitBoundEvent(attribute: TmplAstBoundEvent): void;
    visitText(text: TmplAstText): void;
    visitBoundText(text: TmplAstBoundText): void;
    visitIcu(icu: TmplAstIcu): void;
    /**
     * Visits all the provided nodes in order using this Visitor's visit methods.
     * This is a simplified variant of the `visitAll` function found inside of (but not
     * exported from) the `@angular/compiler` that does not support returning a value
     * since the migrations do not directly transform the nodes.
     *
     * @param nodes An iterable of nodes to visit using this visitor.
     */
    visitAll(nodes: Iterable<TmplAstNode>): void;
}