Function parse

parse(input): DotASTNode
parse is a function that takes a string input and optional parse options and returns an ASTNode or an array of ClusterStatementASTNodes.

Depending on the type of parse option specified, the function will return different types of ASTNodes.

The types of ASTNodes that can be returned are:
Parameters
- input: string
Returns DotASTNode
Throws
DotSyntaxError
- Defined in packages/ast/src/dot-shim/parser/parse.ts:66
parse(input, options?): DotASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Dot">
Returns DotASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:67
parse(input, options?): GraphASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Graph">
Returns GraphASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:68
parse(input, options?): NodeASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Node">
Returns NodeASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:72
parse(input, options?): EdgeASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Edge">
Returns EdgeASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:76
parse(input, options?): AttributeListASTNode
Parameters
- input: string
- Optional options: ParseOptions<"AttributeList">
Returns AttributeListASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:80
parse(input, options?): AttributeASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Attribute">
Returns AttributeASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:84
parse(input, options?): SubgraphASTNode
Parameters
- input: string
- Optional options: ParseOptions<"Subgraph">
Returns SubgraphASTNode
- Defined in packages/ast/src/dot-shim/parser/parse.ts:88
parse(input, options?): ClusterStatementASTNode[]
Parameters
- input: string
- Optional options: ParseOptions<"ClusterStatements">
Returns ClusterStatementASTNode[]
- Defined in packages/ast/src/dot-shim/parser/parse.ts:92
parse(input, options?): ASTNode | ClusterStatementASTNode[]
Parameters
- input: string
- Optional options: ParseOptions<Rule>
Returns ASTNode | ClusterStatementASTNode[]
- Defined in packages/ast/src/dot-shim/parser/parse.ts:96

Generated using TypeDoc