Document the meta field on a retrySlice

miraclx · May 2, 2020 · 515f42e · 515f42e
1 parent 493923c
commit 515f42e
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -148,6 +148,7 @@ At which point, it would abruptly destroy other chunk connections.
 ### Event: 'retry'
 
 * `retrySlice`:
+  * `meta`: &lt;[boolean][]&gt; Whether or not the error causing the retry was caused while getting the URL metadata. i.e before any streams are employed.
   * `index`: &lt;[number][]&gt; The index count of the chunk.
   * `retryCount`: &lt;[number][]&gt; The number of retry iterations so far.
   * `maxRetries`: &lt;[number][]&gt; The maximum number of retries possible.