From 8833adb41f27914349a478225b4be9640a48fa3d Mon Sep 17 00:00:00 2001
From: Tuyen Nguyen <vutuyen2636@gmail.com>
Date: Tue, 20 Aug 2024 15:09:05 +0700
Subject: [PATCH] fix: add jsdoc for ViewDU.commit() api

---
 packages/ssz/src/viewDU/abstract.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/packages/ssz/src/viewDU/abstract.ts b/packages/ssz/src/viewDU/abstract.ts
index 144268f5..0cf8476c 100644
--- a/packages/ssz/src/viewDU/abstract.ts
+++ b/packages/ssz/src/viewDU/abstract.ts
@@ -29,6 +29,9 @@ export type NodeWithCachedTreeRoot = {
 export abstract class TreeViewDU<T extends CompositeType<unknown, unknown, unknown>> extends TreeView<T> {
   /**
    * Applies any deferred updates that may be pending in this ViewDU instance and updates its internal `Node`.
+   * @param hcOffset The offset of the current node from root
+   * @param hcByLevel The global HashComputationLevel array, this is output parameter
+   * These are optional parameters that are used to compute hashTreeRoot() in batch if they are provided.
    */
   abstract commit(hcOffset?: number, hcByLevel?: HashComputationLevel[] | null): void;