New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@vuedx/template-ast-types

Package Overview
Dependencies
Maintainers
1
Versions
141
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vuedx/template-ast-types - npm Package Compare versions

Comparing version 0.7.4-next-1651055813.0 to 0.7.4-next-1663917928.0

lib/index.cjs

204

lib/index.d.ts

@@ -1,197 +0,7 @@

import { Node, RootNode, ElementNode, PlainElementNode, ComponentNode, SlotOutletNode, TemplateNode, TextNode, CommentNode, SimpleExpressionNode, InterpolationNode, AttributeNode, DirectiveNode, SourceLocation } from '@vue/compiler-core';
export { AttributeNode, CommentNode, ComponentNode, DirectiveNode, ElementNode, InterpolationNode, Node, PlainElementNode, RootNode, SimpleExpressionNode, SourceLocation, TemplateNode, TextNode } from '@vue/compiler-core';
/**
* Checks if it is a valid JavaScript identifers.
*
* @public
*/
declare function isSimpleIdentifier(content: string): boolean;
/**
* Checks if it is Vue template AST Node.
*
* @public
*/
declare function isNode(node: unknown): node is Node;
/**
* Checks if it is an AST RootNode.
*
* @public
*/
declare function isRootNode(node: unknown): node is RootNode;
/**
* Checks if it is an AST ElementNode.
*
* @public
*/
declare function isElementNode(node: unknown): node is ElementNode;
/**
* Checks if it is an AST PlainElementNode.
*
* @public
*/
declare function isPlainElementNode(node: unknown): node is PlainElementNode;
/**
* Checks if it is an AST ComponentNode.
*
* @public
*/
declare function isComponentNode(node: unknown): node is ComponentNode;
/**
* Checks if it is an AST SlotNode.
*
* @public
*/
declare function isSlotNode(node: unknown): node is SlotOutletNode;
/**
* Checks if it is an AST TemplateNode.
* @public
*/
declare function isTemplateNode(node: unknown): node is TemplateNode;
/**
* Checks if it is an AST TextNode.
* @public
*/
declare function isTextNode(node: unknown): node is TextNode;
/**
* Checks if it is an AST CommentNode.
* @public
*/
declare function isCommentNode(node: unknown): node is CommentNode;
/**
* Checks if it is an AST ExpressionNode.
* @public
*/
declare function isSimpleExpressionNode(node: unknown): node is SimpleExpressionNode;
/**
* Checks if it is an AST InterpolationNode.
* @public
*/
declare function isInterpolationNode(node: unknown): node is InterpolationNode;
/**
* Checks if it is an AST AttributeNode.
* @public
*/
declare function isAttributeNode(node: unknown): node is AttributeNode;
/**
* Checks if it is an AST DirectiveNode.
* @public
*/
declare function isDirectiveNode(node: unknown): node is DirectiveNode;
/**
* Create AST Node
*
* @public
*/
declare function createSimpleExpression(content: SimpleExpressionNode['content'], isStatic: SimpleExpressionNode['isStatic'], loc?: SourceLocation, isConstant?: boolean): SimpleExpressionNode;
/**
* @public
*/
declare type TraversalAncestors = Array<{
node: Node;
key: string;
index?: number;
}>;
/**
* @public
*/
declare type TraversalHandler<T> = (node: Node, ancestors: TraversalAncestors, state: T) => void;
/**
* @public
*/
interface TraversalHandlers<T> {
enter?: TraversalHandler<T>;
exit?: TraversalHandler<T>;
}
/**
* A general AST traversal utility with both prefix and postfix handlers, and a
* state object. Exposes ancestry data to each handler so that more complex
* AST data can be taken into account.
*
* @public
*/
declare function traverse<T>(node: Node, handlers: TraversalHandler<T> | TraversalHandlers<T>, state?: T): void;
/**
* An abortable AST traversal utility. Return false (or falsy value) to stop traversal.
*
* @public
*/
declare function traverseEvery<T>(node: Node, enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean, state?: any, ancestors?: TraversalAncestors): void;
/**
* A faster AST traversal utility. It behaves same as [traverse()] but there is no ancestory data.
*
* @public
*/
declare function traverseFast<T = any>(node: object, enter: (node: Node, state: T, stop: () => void) => void, state?: T): void;
/**
* @public
*/
interface SearchResult {
node: Node | null;
ancestors: TraversalAncestors;
}
/**
* Find the deepest node containing the given position.
*
* @public
*/
declare function findTemplateNodeAt(ast: RootNode, position: number): SearchResult;
/**
* Find the parent element node.
*
* @public
*/
declare function findParentNode(ast: RootNode, node: Node): ElementNode | undefined;
/**
* Find a child (element, component, text, interpolation, or comment) node containing the given position.
*
* @public
* @param mode - Open/close range comparison mode:
* • undefined - position in [start, end]
* • 'start' — position in [start, end)
* • 'end' - position in (start, end]
*/
declare function findTemplateChildNodeAt(ast: RootNode, position: number, mode?: 'start' | 'end'): SearchResult;
/**
* Find the deepest node containing the given position.
*
* @public
* @param mode - Open/close range comparison mode:
* • undefined - position in [start, end]
* • 'start' — position in [start, end)
* • 'end' - position in (start, end]
*/
declare function findTemplateNodeInRange(ast: RootNode, start: number, end: number, mode?: 'start' | 'end'): SearchResult;
/**
* Get all nodes contained in given range. (partial overlaps are ignored)
*
* @public
*/
declare function findTemplateNodesInRange(ast: RootNode, start: number, end: number): Node[];
/**
* Get all child (element, component, text, interpolation, or comment) nodes contained in given range. (partial overlaps are ignored)
*
* @public
*/
declare function findTemplateChildrenInRange(ast: RootNode, start: number, end: number): Node[];
/**
* @public
*/
interface StringifyOptions {
indent: number;
initialIndent: number;
directive: 'shorthand' | 'longhand';
replaceNodes: Map<Node, Node | null>;
}
/**
* Convert template AST to template code.
*
* @public
*/
declare function stringify(node: Node | Node[], options?: Partial<StringifyOptions>): string;
export { SearchResult, StringifyOptions, TraversalAncestors, TraversalHandler, TraversalHandlers, createSimpleExpression, findParentNode, findTemplateChildNodeAt, findTemplateChildrenInRange, findTemplateNodeAt, findTemplateNodeInRange, findTemplateNodesInRange, isAttributeNode, isCommentNode, isComponentNode, isDirectiveNode, isElementNode, isInterpolationNode, isNode, isPlainElementNode, isRootNode, isSimpleExpressionNode, isSimpleIdentifier, isSlotNode, isTemplateNode, isTextNode, stringify, traverse, traverseEvery, traverseFast };
export * from './assert';
export * from './create';
export * from './node';
export * from './helpers';
export * from './stringify';
export * from './traverse';
//# sourceMappingURL=index.d.ts.map
{
"name": "@vuedx/template-ast-types",
"version": "0.7.4-next-1651055813.0",
"description": "Helper functions for Vue template AST",
"main": "lib/index.js",
"module": "lib/index.mjs",
"types": "lib/index.d.ts",
"publishConfig": {
"types": "lib/index.d.ts"
},
"files": [
"lib"
],
"keywords": [
"ast",
"ast-helpers",
"vue",
"vue-compiler",
"vue-template-compiler"
],
"repository": {
"type": "git",
"url": "git+https://github.com/znck/vue-developer-experience.git"
},
"author": "Rahul Kadyan <rahulkdn@gmail.com> (https://znck.me/)",
"funding": {
"type": "individual",
"url": "https://github.com/sponsors/znck"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/znck/vue-developer-experience/issues"
},
"homepage": "https://github.com/znck/vue-developer-experience#readme",
"dependencies": {
"@vue/compiler-core": "^3.2.31"
},
"devDependencies": {
"typescript": "^4.6.3"
}
}
"name": "@vuedx/template-ast-types",
"version": "0.7.4-next-1663917928.0",
"description": "Helper functions for Vue template AST",
"main": "lib/index.cjs",
"module": "lib/index.mjs",
"types": "lib/index.d.ts",
"files": [
"lib/index.cjs",
"lib/index.mjs",
"lib/index.d.ts"
],
"keywords": [
"ast",
"ast-helpers",
"vue",
"vue-compiler",
"vue-template-compiler"
],
"repository": {
"type": "git",
"url": "git+https://github.com/znck/vue-developer-experience.git"
},
"author": "Rahul Kadyan <rahulkdn@gmail.com> (https://znck.me/)",
"funding": {
"type": "individual",
"url": "https://github.com/sponsors/znck"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/znck/vue-developer-experience/issues"
},
"homepage": "https://github.com/znck/vue-developer-experience#readme",
"dependencies": {
"@vue/compiler-core": "^3.2.31"
},
"devDependencies": {
"typescript": "^4.6.3"
}
}

@@ -18,2 +18,3 @@ <div align="center" style="text-align: center; margin-bottom: 72px">

<a href="#-vuedx-template-ast-types-createSimpleExpression-function-1-" id="-vuedx-template-ast-types-createSimpleExpression-function-1-"></a>

@@ -29,18 +30,12 @@

**Signature:**
```ts
declare function createSimpleExpression(
content: SimpleExpressionNode['content'],
isStatic: SimpleExpressionNode['isStatic'],
loc?: SourceLocation,
isConstant?: boolean,
): SimpleExpressionNode
export declare function createSimpleExpression(content: SimpleExpressionNode['content'], isStatic: SimpleExpressionNode['isStatic'], loc?: SourceLocation, isConstant?: boolean): SimpleExpressionNode;
```
| Parameter | Type | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------- | ----------- |
| content | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['content']</code> | - |
| isStatic | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['isStatic']</code> | - |
| loc | <code><a href="#-vue-compiler-core-SourceLocation-interface">SourceLocation</a></code> | - |
| isConstant | <code>boolean</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| content | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['content']</code> | - |
| isStatic | <code><a href="#-vue-compiler-core-SimpleExpressionNode-interface">SimpleExpressionNode</a>['isStatic']</code> | - |
| loc | <code><a href="#-vue-compiler-core-SourceLocation-interface">SourceLocation</a></code> | - |
| isConstant | <code>boolean</code> | - |

@@ -60,14 +55,10 @@ </details>

**Signature:**
```ts
declare function findParentNode(
ast: RootNode,
node: Node,
): ElementNode | undefined
export declare function findParentNode(ast: RootNode, node: Node): ElementNode | undefined;
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ----------- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| node | <code><a href="#-vue-compiler-core-Node-2-interface">Node</a></code> | - |

@@ -87,16 +78,11 @@ </details>

**Signature:**
```ts
declare function findTemplateChildNodeAt(
ast: RootNode,
position: number,
mode?: 'start' | 'end',
): SearchResult
export declare function findTemplateChildNodeAt(ast: RootNode, position: number, mode?: 'start' | 'end'): SearchResult;
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| position | <code>number</code> | - |
| mode | <code>'start' &#124; 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| position | <code>number</code> | - |
| mode | <code>'start' &#124; 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] |

@@ -116,16 +102,11 @@ </details>

**Signature:**
```ts
declare function findTemplateChildrenInRange(
ast: RootNode,
start: number,
end: number,
): Node[]
export declare function findTemplateChildrenInRange(ast: RootNode, start: number, end: number): Node[];
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ----------- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |

@@ -145,14 +126,10 @@ </details>

**Signature:**
```ts
declare function findTemplateNodeAt(
ast: RootNode,
position: number,
): SearchResult
export declare function findTemplateNodeAt(ast: RootNode, position: number): SearchResult;
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ----------- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| position | <code>number</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| position | <code>number</code> | - |

@@ -172,18 +149,12 @@ </details>

**Signature:**
```ts
declare function findTemplateNodeInRange(
ast: RootNode,
start: number,
end: number,
mode?: 'start' | 'end',
): SearchResult
export declare function findTemplateNodeInRange(ast: RootNode, start: number, end: number, mode?: 'start' | 'end'): SearchResult;
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |
| mode | <code>'start' &#124; 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |
| mode | <code>'start' &#124; 'end'</code> | Open/close range comparison mode: • undefined - position in [start, end] • 'start' — position in [start, end) • 'end' - position in (start, end] |

@@ -203,16 +174,11 @@ </details>

**Signature:**
```ts
declare function findTemplateNodesInRange(
ast: RootNode,
start: number,
end: number,
): Node[]
export declare function findTemplateNodesInRange(ast: RootNode, start: number, end: number): Node[];
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ----------- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| ast | <code><a href="#-vue-compiler-core-RootNode-interface">RootNode</a></code> | - |
| start | <code>number</code> | - |
| end | <code>number</code> | - |

@@ -232,10 +198,9 @@ </details>

**Signature:**
```ts
declare function isAttributeNode(node: unknown): node is AttributeNode
export declare function isAttributeNode(node: unknown): node is AttributeNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -255,10 +220,9 @@ </details>

**Signature:**
```ts
declare function isCommentNode(node: unknown): node is CommentNode
export declare function isCommentNode(node: unknown): node is CommentNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -278,10 +242,30 @@ </details>

**Signature:**
```ts
export declare function isComponentNode(node: unknown): node is ComponentNode;
```
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |
</details>
<br>
<a href="#-vuedx-template-ast-types-isCompoundExpressionNode-function-1-" id="-vuedx-template-ast-types-isCompoundExpressionNode-function-1-"></a>
### [isCompoundExpressionNode](#-vuedx-template-ast-types-isCompoundExpressionNode-function-1-)
Checks if it is an AST ExpressionNode.
<details>
<summary>More info</summary>
**Signature:**
```ts
declare function isComponentNode(node: unknown): node is ComponentNode
export declare function isCompoundExpressionNode(node: unknown): node is SimpleExpressionNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -301,10 +285,9 @@ </details>

**Signature:**
```ts
declare function isDirectiveNode(node: unknown): node is DirectiveNode
export declare function isDirectiveNode(node: unknown): node is DirectiveNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -324,10 +307,30 @@ </details>

**Signature:**
```ts
export declare function isElementNode(node: unknown): node is ElementNode;
```
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |
</details>
<br>
<a href="#-vuedx-template-ast-types-isExpressionNode-function-1-" id="-vuedx-template-ast-types-isExpressionNode-function-1-"></a>
### [isExpressionNode](#-vuedx-template-ast-types-isExpressionNode-function-1-)
Checks if it is an AST ExpressionNode.
<details>
<summary>More info</summary>
**Signature:**
```ts
declare function isElementNode(node: unknown): node is ElementNode
export declare function isExpressionNode(node: unknown): node is ExpressionNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -347,10 +350,9 @@ </details>

**Signature:**
```ts
declare function isInterpolationNode(node: unknown): node is InterpolationNode
export declare function isInterpolationNode(node: unknown): node is InterpolationNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -370,10 +372,9 @@ </details>

**Signature:**
```ts
declare function isNode(node: unknown): node is Node
export declare function isNode(node: unknown): node is Node;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -393,10 +394,9 @@ </details>

**Signature:**
```ts
declare function isPlainElementNode(node: unknown): node is PlainElementNode
export declare function isPlainElementNode(node: unknown): node is PlainElementNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -416,10 +416,9 @@ </details>

**Signature:**
```ts
declare function isRootNode(node: unknown): node is RootNode
export declare function isRootNode(node: unknown): node is RootNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -439,12 +438,9 @@ </details>

**Signature:**
```ts
declare function isSimpleExpressionNode(
node: unknown,
): node is SimpleExpressionNode
export declare function isSimpleExpressionNode(node: unknown): node is SimpleExpressionNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -458,3 +454,3 @@ </details>

Checks if it is a valid JavaScript identifers.
Checks if it is a valid JavaScript identifiers.

@@ -465,10 +461,30 @@ <details>

**Signature:**
```ts
export declare function isSimpleIdentifier(content: string): boolean;
```
| Parameter | Type | Description |
| --- | --- | --- |
| content | <code>string</code> | - |
</details>
<br>
<a href="#-vuedx-template-ast-types-isSlotNode-function-1-" id="-vuedx-template-ast-types-isSlotNode-function-1-"></a>
### [isSlotNode](#-vuedx-template-ast-types-isSlotNode-function-1-)
Checks if it is an AST SlotNode.
<details>
<summary>More info</summary>
**Signature:**
```ts
declare function isSimpleIdentifier(content: string): boolean
export declare function isSlotNode(node: unknown): node is SlotOutletNode;
```
| Parameter | Type | Description |
| --------- | ------------------- | ----------- |
| content | <code>string</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -488,10 +504,9 @@ </details>

**Signature:**
```ts
declare function isTemplateNode(node: unknown): node is TemplateNode
export declare function isTemplateNode(node: unknown): node is TemplateNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -511,10 +526,9 @@ </details>

**Signature:**
```ts
declare function isTextNode(node: unknown): node is TextNode
export declare function isTextNode(node: unknown): node is TextNode;
```
| Parameter | Type | Description |
| --------- | -------------------- | ----------- |
| node | <code>unknown</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>unknown</code> | - |

@@ -534,14 +548,10 @@ </details>

**Signature:**
```ts
declare function stringify(
node: Node | Node[],
options?: Partial<StringifyOptions>,
): string
export declare function stringify(node: Node | Node[], options?: Partial<StringifyOptions>): string;
```
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a> &#124; <a href="#-vue-compiler-core--Node-2-interface">Node</a>[]</code> | - |
| options | <code><a href="#-Partial-type">Partial</a><<a href="#-vuedx-template-ast-types--StringifyOptions-interface">StringifyOptions</a>></code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code><a href="#-vue-compiler-core-Node-2-interface">Node</a> &#124; <a href="#-vue-compiler-core-Node-2-interface">Node</a>[]</code> | - |
| options | <code><a href="#-Partial-type">Partial</a><<a href="#-vuedx-template-ast-types-StringifyOptions-interface">StringifyOptions</a>></code> | - |

@@ -561,16 +571,11 @@ </details>

**Signature:**
```ts
declare function traverse<T>(
node: Node,
handlers: TraversalHandler<T> | TraversalHandlers<T>,
state?: T,
): void
export declare function traverse<T>(node: Node, handlers: TraversalHandler<T> | TraversalHandlers<T>, state?: T): void;
```
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - |
| handlers | <code><a href="#-vuedx-template-ast-types--TraversalHandler-type">TraversalHandler</a><T> &#124; <a href="#-vuedx-template-ast-types--TraversalHandlers-interface">TraversalHandlers</a><T></code> | - |
| state | <code>T</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code><a href="#-vue-compiler-core-Node-2-interface">Node</a></code> | - |
| handlers | <code><a href="#-vuedx-template-ast-types-TraversalHandler-type">TraversalHandler</a><T> &#124; <a href="#-vuedx-template-ast-types-TraversalHandlers-interface">TraversalHandlers</a><T></code> | - |
| state | <code>T</code> | - |

@@ -590,18 +595,12 @@ </details>

**Signature:**
```ts
declare function traverseEvery<T>(
node: Node,
enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean,
state?: any,
ancestors?: TraversalAncestors,
): void
export declare function traverseEvery<T>(node: Node, enter: (node: Node, ancestors: TraversalAncestors, state: T) => boolean, state?: any, ancestors?: TraversalAncestors): void;
```
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| node | <code><a href="#-vue-compiler-core--Node-2-interface">Node</a></code> | - |
| enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, ancestors: <a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a>, state: T) => boolean</code> | - |
| state | <code>any</code> | - |
| ancestors | <code><a href="#-vuedx-template-ast-types--TraversalAncestors-type">TraversalAncestors</a></code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code><a href="#-vue-compiler-core-Node-2-interface">Node</a></code> | - |
| enter | <code>(node: <a href="#-vue-compiler-core-Node-2-interface">Node</a>, ancestors: <a href="#-vuedx-template-ast-types-TraversalAncestors-type">TraversalAncestors</a>, state: T) => boolean</code> | - |
| state | <code>any</code> | - |
| ancestors | <code><a href="#-vuedx-template-ast-types-TraversalAncestors-type">TraversalAncestors</a></code> | - |

@@ -621,16 +620,11 @@ </details>

**Signature:**
```ts
declare function traverseFast<T = any>(
node: object,
enter: (node: Node, state: T, stop: () => void) => void,
state?: T,
): void
export declare function traverseFast<T = any>(node: object, enter: (node: Node, state: T, stop: () => void) => void, state?: T): void;
```
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------- | ----------- |
| node | <code>object</code> | - |
| enter | <code>(node: <a href="#-vue-compiler-core--Node-2-interface">Node</a>, state: T, stop: () => void) => void</code> | - |
| state | <code>T</code> | - |
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>object</code> | - |
| enter | <code>(node: <a href="#-vue-compiler-core-Node-2-interface">Node</a>, state: T, stop: () => void) => void</code> | - |
| state | <code>T</code> | - |

@@ -642,2 +636,3 @@ </details>

<a href="#-vuedx-template-ast-types-SearchResult-interface" id="-vuedx-template-ast-types-SearchResult-interface"></a>

@@ -647,9 +642,12 @@

```ts
interface SearchResult {
ancestors: TraversalAncestors
node: Node | null
export interface SearchResult {
ancestors: TraversalAncestors;
node: Node | null;
}
```
<br>

@@ -661,11 +659,14 @@

```ts
interface StringifyOptions {
directive: 'shorthand' | 'longhand'
indent: number
initialIndent: number
replaceNodes: Map<Node, Node | null>
export interface StringifyOptions {
directive: 'shorthand' | 'longhand';
indent: number;
initialIndent: number;
replaceNodes: Map<Node, Node | null>;
}
```
<br>

@@ -677,9 +678,12 @@

```ts
interface TraversalHandlers<T> {
enter?: TraversalHandler<T>
exit?: TraversalHandler<T>
export interface TraversalHandlers<T> {
enter?: TraversalHandler<T>;
exit?: TraversalHandler<T>;
}
```
<br>

@@ -686,0 +690,0 @@ <!-- #region API-DOCS -->

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc