Skip to content

Commit

Permalink
fix: add jsdoc for ViewDU.commit() api
Browse files Browse the repository at this point in the history
  • Loading branch information
twoeths committed Aug 20, 2024
1 parent 303ffff commit 8833adb
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/ssz/src/viewDU/abstract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit 8833adb

Please sign in to comment.