From f6fd59a512aa2cadbcb5864625e6eff533656513 Mon Sep 17 00:00:00 2001
From: Irakli Gozalishvili <contact@gozala.io>
Date: Wed, 30 Mar 2022 17:52:59 -0700
Subject: [PATCH] chore: regenerate docs

---
 README.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e90137e..06070b6 100644
--- a/README.md
+++ b/README.md
@@ -244,6 +244,7 @@ be directly fed to a
  * [`CarBufferWriter#addRoot(root, options)`](#CarBufferWriter_addRoot)
  * [`CarBufferWriter#write(block)`](#CarBufferWriter_write)
  * [`CarBufferWriter#close([options])`](#CarBufferWriter_close)
+ * [`CarBufferWriter.blockLength(Block)`](#CarBufferWriter__blockLength__Block__)
  * [`CarBufferWriter.calculateHeaderLength(rootLengths)`](#CarBufferWriter__calculateHeaderLength__rootLengths__)
  * [`CarBufferWriter.headerLength({ roots })`](#CarBufferWriter__headerLength______roots______)
  * [`CarBufferWriter.estimateHeaderLength(rootCount[, rootByteLength])`](#CarBufferWriter__estimateHeaderLength__rootCount______rootByteLength____)
@@ -810,6 +811,16 @@ Throws if there is not enough capacity.
 
 Finalize the CAR and return it as a `Uint8Array`.
 
+<a name="CarBufferWriter__blockLength__Block__"></a>
+### `CarBufferWriter.blockLength(Block)`
+
+* `block` `(Block)`
+
+* Returns:  `number`
+
+Calculates number of bytes required for storing given block in CAR. Useful in
+estimating size of an `ArrayBuffer` for the `CarBufferWriter`.
+
 <a name="CarBufferWriter__calculateHeaderLength__rootLengths__"></a>
 ### `CarBufferWriter.calculateHeaderLength(rootLengths)`
 
@@ -822,8 +833,8 @@ Calculates header size given the array of byteLength for roots.
 <a name="CarBufferWriter__headerLength______roots______"></a>
 ### `CarBufferWriter.headerLength({ roots })`
 
-* `options` `(Object)`
-  * `options.roots` `(CID[], optional)`
+* `options` `(object)`
+  * `options.roots` `(CID[])`
 
 * Returns:  `number`
 
@@ -845,7 +856,7 @@ single-byte multihash code, such as SHA2-256 (i.e. the most common CIDv1).
 ### `CarBufferWriter.createWriter(buffer[, options])`
 
 * `buffer` `(ArrayBuffer)`
-* `options` `(Options, optional)`
+* `options` `(object, optional)`
   * `options.roots` `(CID[], optional)`
   * `options.byteOffset` `(number, optional)`
   * `options.byteLength` `(number, optional)`