From 07c8ddeb6e07a83ea1f0a5d6394d033667e27c1d Mon Sep 17 00:00:00 2001
From: Jerome Wu <jeromewus@gmail.com>
Date: Tue, 3 Nov 2020 22:46:09 +0800
Subject: [PATCH] Add fetchFile to api doc

---
 docs/api.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/api.md b/docs/api.md
index cae607c..e5ac33c 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -7,6 +7,7 @@
   - [ffmpeg.setLogging](#ffmpeg-setlogging)
   - [ffmpeg.setLogger](#ffmpeg-setlogger)
   - [ffmpeg.setProgress](#ffmpeg-setProgress)
+- [fetchFile](#fetch-file)
 
 ---
 
@@ -159,3 +160,28 @@ ffmpeg.setProgress(({ ratio }) => {
    */
 });
 ```
+
+<a name="fetch-file"></a>
+
+### fetchFile(media): Promise
+   
+Helper function for fetching files from various resource.
+
+Sometimes the video/audio file you want to process may located in a remote URL and somewhere in your local file system.
+   
+This helper function helps you to fetch to file and return an Uint8Array variable for ffmpeg.wasm to consume.
+
+**Arguments**
+
+- `media` an URL string, base64 string or File, Blob, Buffer object
+
+**Examples:**
+
+```javascript
+(async () => {
+  const data = await fetchFile('https://github.com/ffmpegwasm/testdata/raw/master/video-3s.avi');
+  /*
+   * data will be in Uint8Array format
+   */
+})();
+```