Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Thanga-Ganapathy committed Apr 9, 2024
1 parent a7e3a38 commit 3612706
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/small-buttons-poke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@opentf/cli-pbar': patch
---

Updated docs.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,15 +214,15 @@ After the method is called, the progress bar starts rendering.

### add(bar: Partial<Bar\>): { update: (bar: Partial<Bar\>) => void }

In `multi-progress` bars, it appends a progress bar to the container and returns an object with a method to update it.
In `multi-progress`, it appends a progress bar to the container and returns an instance.

### update(bar: Partial<Bar\>): void

In updates the current progress bar instance.
It is used to update the current progress bar instance.

### inc(bar: Partial<Bar\>): void

In increments the progress bar value and optionaly updates the other bar props.
It increments the progress bar value and optionaly updates the other bar props.

### stop(msg?: string): void

Expand Down

0 comments on commit 3612706

Please sign in to comment.