cdk-utilities
v0.0.7
Published
## **Please Advise** This project is currently in development... all releases pre 0.1.0 are to be considered experimental
Downloads
8
Keywords
Readme
CDK Utilities
Please Advise
This project is currently in development... all releases pre 0.1.0 are to be considered experimental
Purpose
Creating some interesting CDK Utility classes to provide deeper insights into deployable resources and construct trees
API Reference
Structs
KvMap
Initializer
import { KvMap } from 'cdk-utilities'
const kvMap: KvMap = { ... }
Classes
ConstructTreeParser
Initializer
import { ConstructTreeParser } from 'cdk-utilities'
new ConstructTreeParser(node: App)
node
Required
- Type:
@aws-cdk/core.App
Methods
generateParseTree
public generateParseTree()
generateTreeStructure
public generateTreeStructure()
Properties
rootNode
Required
- Type:
@aws-cdk/core.App
Node
Initializer
import { Node } from 'cdk-utilities'
new Node(node: ConstructNode, parent?: Node, children?: Node[])
node
Required
parent
Optional
- Type:
cdk-utilities.Node
children
Optional
- Type:
cdk-utilities.Node
[]
Methods
accept
public accept(visitor: IVisitor)
visitor
Required
- Type:
cdk-utilities.IVisitor
addChild
public addChild(node: Node)
node
Required
- Type:
cdk-utilities.Node
Properties
nodeId
Required
- Type:
string
nodePath
Required
- Type:
string
originalNode
Required
childrenNodes
Required
- Type:
cdk-utilities.Node
[]
parentNode
Required
- Type:
cdk-utilities.Node
ParseTree
Initializer
import { ParseTree } from 'cdk-utilities'
new ParseTree(app: App)
app
Required
- Type:
@aws-cdk/core.App
Methods
createTree
public createTree(constructNode: ConstructNode, parent?: Node)
constructNode
Required
parent
Optional
- Type:
cdk-utilities.Node
findPaths
public findPaths()
genTreeStructure
public genTreeStructure()
PrintTreeStructureVisitor
- Implements:
cdk-utilities.IVisitor
Initializer
import { PrintTreeStructureVisitor } from 'cdk-utilities'
new PrintTreeStructureVisitor()
Methods
makeIndent
public makeIndent()
postVisit
public postVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
preVisit
public preVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
visit
public visit(node: Node)
node
Required
- Type:
cdk-utilities.Node
Properties
indent
Required
- Type:
string
indentLevel
Required
- Type:
number
knownChildrenSeen
Required
- Type:
cdk-utilities.KvMap
lastIndentLevel
Required
- Type:
number
output
Required
- Type:
string
PrintVisitor
- Implements:
cdk-utilities.IVisitor
Initializer
import { PrintVisitor } from 'cdk-utilities'
new PrintVisitor()
Methods
postVisit
public postVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
preVisit
public preVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
visit
public visit(node: Node)
node
Required
- Type:
cdk-utilities.Node
Properties
paths
Required
- Type:
string
Protocols
IVisitor
- Implemented By:
cdk-utilities.PrintTreeStructureVisitor
,cdk-utilities.PrintVisitor
,cdk-utilities.IVisitor
Methods
postVisit
public postVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
preVisit
public preVisit(node: Node)
node
Required
- Type:
cdk-utilities.Node
visit
public visit(node: Node)
node
Required
- Type:
cdk-utilities.Node