Skip to content

Commit a4eb6d3

Browse files
authored
docs/add-new-methods (#12)
1 parent 2f3dedc commit a4eb6d3

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ go get -u github.com/johnfercher/go-tree
3434
* [AddNext](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.AddNext)
3535
* [Backtrack](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.Backtrack)
3636
* [Get](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.Get)
37+
* [GetNexts](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.GetNexts)
38+
* [GetPrevious](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.GetPrevious)
3739
* [GetStructure](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.GetStructure)
3840
* [IsLeaf](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.IsLeaf)
3941
* [IsRoot](https://pkg.go.dev/github.com/johnfercher/go-tree/tree#Node.IsLeaf)

tree/example_test.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,18 @@ func ExampleNode_GetNexts() {
133133
// Do more things
134134
}
135135

136+
// ExampleNode_GetPrevious demonstrates how to retrieve next nodes from node.
137+
func ExampleNode_GetPrevious() {
138+
root := tree.NewNode(0, "root")
139+
leaf := tree.NewNode(1, "leaf")
140+
141+
root.AddNext(leaf)
142+
previous := leaf.GetPrevious()
143+
fmt.Println(previous.Get())
144+
145+
// Do more things
146+
}
147+
136148
// ExampleNode_IsRoot demonstrates how to retrieve info if node is root.
137149
func ExampleNode_IsRoot() {
138150
n := tree.NewNode(0, 'b')

0 commit comments

Comments
 (0)