Skip to content

docs: note exception-safe cleanup of JS Yoga trees #1999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
greekr4 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: note exception-safe cleanup of JS Yoga trees #1999

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions website/docs/getting-started/laying-out-a-tree.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ root.insertChild(child1, 1);

Yoga Nodes are not freed automatically and should be discarded when no longer needed. Individual nodes may be freed by calling `node.free()`, or an entire Yoga tree may be freed by calling `node.freeRecursive()`.

Nodes live in the WebAssembly heap, which is not visible to the JavaScript garbage collector. An application which repeatedly leaks nodes will grow the heap until new nodes fail to allocate. If an exception may be thrown after nodes are created (e.g. from within a [measure function](../advanced/external-layout-systems.mdx) during layout), freeing in a `finally` block guarantees the tree is released:

```ts
const root = buildYogaTree();
try {
root.calculateLayout(undefined, undefined, Direction.LTR);
readLayoutResults(root);
} finally {
root.freeRecursive();
}
```

A future revision of JavaScript bindings for Yoga may move to garbage collection to remove this requirement.

:::
Expand Down