template-ast-types.api.md

API Report File for "@vuedx/template-ast-types"

Do not edit this file. It is a report generated by API Extractor.

import { AttributeNode } from '@vue/compiler-core';
import { CommentNode } from '@vue/compiler-core';
import { ComponentNode } from '@vue/compiler-core';
import { DirectiveNode } from '@vue/compiler-core';
import { ElementNode } from '@vue/compiler-core';
import { ExpressionNode } from '@vue/compiler-core';
import { InterpolationNode } from '@vue/compiler-core';
import { Node as Node_2 } from '@vue/compiler-core';
import type { NodeTypes as NodeTypes_2 } from '@vue/compiler-core';
import { PlainElementNode } from '@vue/compiler-core';
import { RootNode } from '@vue/compiler-core';
import { SimpleExpressionNode } from '@vue/compiler-core';
import { SlotOutletNode } from '@vue/compiler-core';
import { SourceLocation } from '@vue/compiler-core';
import { TemplateNode } from '@vue/compiler-core';
import { TextNode } from '@vue/compiler-core';

export { AttributeNode }

// @public (undocumented)
export const builtInDirectives: readonly ["bind", "cloak", "else-if", "else", "for", "html", "if", "model", "on", "on", "once", "pre", "show", "slot", "text"];

export { CommentNode }

export { ComponentNode }

// @public
export function createSimpleExpression(content: SimpleExpressionNode['content'], isStatic: SimpleExpressionNode['isStatic'], loc?: SourceLocation, isConstant?: boolean): SimpleExpressionNode;

export { DirectiveNode }

export { ElementNode }

// @public (undocumented)
export const ElementTypes: {
    ELEMENT: number;
    COMPONENT: number;
    SLOT: number;
    TEMPLATE: number;
};

// @public
export function findParentNode(ast: RootNode, node: Node_2): ElementNode | undefined;

// @public
export function findTemplateChildNodeAt(ast: RootNode, position: number, mode?: 'start' | 'end'): SearchResult;

// @public
export function findTemplateChildrenInRange(ast: RootNode, start: number, end: number): Node_2[];

// @public
export function findTemplateNodeAt(ast: RootNode, position: number): SearchResult;

// @public
export function findTemplateNodeInRange(ast: RootNode, start: number, end: number, mode?: 'start' | 'end'): SearchResult;

// @public
export function findTemplateNodesInRange(ast: RootNode, start: number, end: number): Node_2[];

export { InterpolationNode }

// @public
export function isAttributeNode(node: unknown): node is AttributeNode;

// @public
export function isCommentNode(node: unknown): node is CommentNode;

// @public
export function isComponentNode(node: unknown): node is ComponentNode;

// @public
export function isCompoundExpressionNode(node: unknown): node is SimpleExpressionNode;

// @public
export function isDirectiveNode(node: unknown): node is DirectiveNode;

// @public
export function isElementNode(node: unknown): node is ElementNode;

// @public
export function isExpressionNode(node: unknown): node is ExpressionNode;

// @public
export function isInterpolationNode(node: unknown): node is InterpolationNode;

// @public
export function isNode(node: unknown): node is Node_2;

// @public
export function isPlainElementNode(node: unknown): node is PlainElementNode;

// @public
export function isRootNode(node: unknown): node is RootNode;

// @public
export function isSimpleExpressionNode(node: unknown): node is SimpleExpressionNode;

// @public
export function isSimpleIdentifier(content: string): boolean;

// @public
export function isSlotNode(node: unknown): node is SlotOutletNode;

// @public
export function isTemplateNode(node: unknown): node is TemplateNode;

// @public
export function isTextNode(node: unknown): node is TextNode;

export { Node_2 as Node }

// @public (undocumented)
export const NodeTypes: {
    ROOT: NodeTypes_2.ROOT;
    ELEMENT: NodeTypes_2.ELEMENT;
    TEXT: NodeTypes_2.TEXT;
    COMMENT: NodeTypes_2.COMMENT;
    SIMPLE_EXPRESSION: NodeTypes_2.SIMPLE_EXPRESSION;
    INTERPOLATION: NodeTypes_2.INTERPOLATION;
    ATTRIBUTE: NodeTypes_2.ATTRIBUTE;
    DIRECTIVE: NodeTypes_2.DIRECTIVE;
    COMPOUND_EXPRESSION: NodeTypes_2.COMPOUND_EXPRESSION;
    IF: NodeTypes_2.IF;
    IF_BRANCH: NodeTypes_2.IF_BRANCH;
    FOR: NodeTypes_2.FOR;
    TEXT_CALL: NodeTypes_2.TEXT_CALL;
    VNODE_CALL: NodeTypes_2.VNODE_CALL;
    JS_CALL_EXPRESSION: NodeTypes_2.JS_CALL_EXPRESSION;
    JS_OBJECT_EXPRESSION: NodeTypes_2.JS_OBJECT_EXPRESSION;
    JS_PROPERTY: NodeTypes_2.JS_PROPERTY;
    JS_ARRAY_EXPRESSION: NodeTypes_2.JS_ARRAY_EXPRESSION;
    JS_FUNCTION_EXPRESSION: NodeTypes_2.JS_FUNCTION_EXPRESSION;
    JS_CONDITIONAL_EXPRESSION: NodeTypes_2.JS_CONDITIONAL_EXPRESSION;
    JS_CACHE_EXPRESSION: NodeTypes_2.JS_CACHE_EXPRESSION;
    JS_BLOCK_STATEMENT: NodeTypes_2.JS_BLOCK_STATEMENT;
    JS_TEMPLATE_LITERAL: NodeTypes_2.JS_TEMPLATE_LITERAL;
    JS_IF_STATEMENT: NodeTypes_2.JS_IF_STATEMENT;
    JS_ASSIGNMENT_EXPRESSION: NodeTypes_2.JS_ASSIGNMENT_EXPRESSION;
    JS_SEQUENCE_EXPRESSION: NodeTypes_2.JS_SEQUENCE_EXPRESSION;
    JS_RETURN_STATEMENT: NodeTypes_2.JS_RETURN_STATEMENT;
};

export { PlainElementNode }

export { RootNode }

// @public (undocumented)
export interface SearchResult {
    // (undocumented)
    ancestors: TraversalAncestors;
    // (undocumented)
    node: Node_2 | null;
}

export { SimpleExpressionNode }

export { SourceLocation }

// @public
export function stringify(node: Node_2 | Node_2[], options?: Partial<StringifyOptions>): string;

// @public (undocumented)
export interface StringifyOptions {
    // (undocumented)
    directive: 'shorthand' | 'longhand';
    // (undocumented)
    indent: number;
    // (undocumented)
    initialIndent: number;
    // (undocumented)
    replaceNodes: Map<Node_2, Node_2 | null>;
}

export { TemplateNode }

export { TextNode }

// @public (undocumented)
export type TraversalAncestors = Array<{
    node: Node_2;
    key: string;
    index?: number;
}>;

// @public (undocumented)
export type TraversalHandler<T> = (node: Node_2, ancestors: TraversalAncestors, state: T) => void;

// @public (undocumented)
export interface TraversalHandlers<T> {
    // (undocumented)
    enter?: TraversalHandler<T>;
    // (undocumented)
    exit?: TraversalHandler<T>;
}

// @public
export function traverse<T>(node: Node_2, handlers: TraversalHandler<T> | TraversalHandlers<T>, state?: T): void;

// @public
export function traverseEvery<T>(node: Node_2, enter: (node: Node_2, ancestors: TraversalAncestors, state: T) => boolean, state?: any, ancestors?: TraversalAncestors): void;

// @public
export function traverseFast<T = any>(node: object, enter: (node: Node_2, state: T, stop: () => void) => void, state?: T): void;

// (No @packageDocumentation comment for this package)