docs(api): document export method (#86)

Author: SamVerschueren

docs/api.md

@@ -310,6 +310,37 @@ Spawns a process with additional arguments.
 
 Spawns a process without additional arguments.
 
+### ▸ `export`
+
+Added in version `1.4.0`.
+
+Exports the filesystem.
+
+<h4 id="wc-export-signature">
+  <a id="wc-export-signature">Signature</a>
+  <a href="#wc-export-signature" class="header-anchor" aria-hidden="true">#</a>
+</h4>
+
+<code>export(path: string, options?: <a href="#exportoptions">ExportOptions</a>): Promise<Uint8Array | <a href="#filesystemtree">FileSystemTree</a>></code>
+
+<h4 id="wc-export-example">
+  <a id="wc-export-example">Example</a>
+  <a href="#wc-export-example" class="header-anchor" aria-hidden="true">#</a>
+</h4>
+
+```js
+const data = await webcontainerInstance.export('dist', { format: 'zip' });
+
+const zip = new Blob([data]);
+```
+
+<h4 id="wc-export-returns">
+  <a id="wc-export-returns">Returns</a>
+  <a href="#wc-spawn-returns" class="header-anchor" aria-hidden="true">#</a>
+</h4>
+
+Returns a [`FileSystemTree`](#filesystemtree) when the format is `json`, otherwise a `Uint8Array`.
+
 ### ▸ `teardown`
 
 Destroys the WebContainer instance, turning it unusable, and releases its resources. After this, a new WebContainer instance can be obtained by calling [`boot`](#▸-boot).
@@ -895,11 +926,11 @@ A tree-like structure to describe the contents of a folder to be mounted.
 
 ```ts
 interface FileSystemTree {
-  [name: string]: FileNode | DirectoryNode;
+  [name: string]: FileNode | SymlinkNode | DirectoryNode;
 }
 ```
 
-Also see [`FileNode`](#filenode) and [`DirectoryNode`](#directorynode).
+Also see [`FileNode`](#filenode), [`SymlinkNode`](#symlinknode), and [`DirectoryNode`](#directorynode).
 
 <h4 id="filesystemtree-example">
   <a id="filesystemtree-example">Example</a>
@@ -915,6 +946,11 @@ const tree = {
           contents: 'const x = 1;',
         },
       },
+      'bar.js': {
+        file: {
+          symlink: './foo.js',
+        },
+      },
       '.envrc': {
         file: {
           contents: 'ENVIRONMENT=staging'
@@ -950,6 +986,26 @@ Represents a file with contents. Also see [`FileSystemTree`](#filesystemtree).
 
 ---
 
+## `SymlinkNode`
+
+```ts
+interface SymlinkNode {
+  file: {
+    symlink: string;
+  };
+}
+```
+
+### `SymlinkNode` Properties
+
+<br />
+
+#### ▸ `file: { symlink: string }`
+
+Represents a symlink pointing to another location. Also see [`FileSystemTree`](#filesystemtree).
+
+---
+
 ## `DirectoryNode`
 
 ```ts
@@ -1011,6 +1067,42 @@ The size of the attached terminal.
 
 ---
 
+## `ExportOptions`
+
+Options that control exporting data.
+
+```ts
+export interface ExportOptions {
+  format?: 'json' | 'binary' | 'zip',
+  includes?: string[];
+  excludes?: string[];
+}
+```
+
+### `ExportOptions` Properties
+
+<br />
+
+#### ▸ `format?: 'json' | 'binary' | 'zip'`
+
+The format of the exported data. The `json` and `binary` format can be used as `tree` when calling [`mount`](#▸-mount).
+
+The default value is `json`.
+
+<br />
+
+#### ▸ `includes?: string[]`
+
+Globbing patterns to include files from within excluded folders.
+
+<br />
+
+#### ▸ `excludes?: string[]`
+
+Globbing patterns to exclude files from the export.
+
+---
+
 ## `WebContainerProcess`
 
 A running process spawned in a [WebContainer](#webcontainer) instance.

docs/changelog.md

@@ -10,6 +10,10 @@ head:
 
 # Changelog
 
+## 1.4.0
+
+* Add support for exporting the file system with [`export`](api#▸-export).
+
 ## 1.3.0
 
 * Breaking change: we now throw if [`auth.init`](api#▸-init) is called after [`WebContainer.boot`](api#▸-boot)