docs(api): document cwd option for spawning processes (#76)

Author: SamVerschueren

docs/api.md

@@ -30,6 +30,18 @@ The main export of this library. An instance of `WebContainer` represents a runt
 
 Gives access to the underlying file system.
 
+<br />
+
+#### <code>path: string</code>
+
+The default value of the `PATH` environment variable for processes started through [`spawn`](#▸-spawn).
+
+<br />
+
+#### <code>workdir: string</code>
+
+The full path to the working directory (see [FileSystemAPI](#filesystemapi)).
+
 ### `WebContainer` Methods
 
 ### ▸ `boot`
@@ -245,16 +257,6 @@ All entities derived from this instance (e.g. processes, the file system, etc.)
 
 ## `auth`
 
-::: warning
-This namespace is currently only available under the `beta` tag. If you want to use it you will need to install this version specifically:
-
-```bash
-npm install @webcontainer/api@beta
-```
-
-We don't guarantee backwards compatibility between beta versions.
-:::
-
 The authentication API is exported under the `auth` namespace. It allows you to authenticate users visiting your website via StackBlitz. In order for users to be authenticated via this method, they must:
 
  * Be logged in on StackBlitz.
@@ -265,8 +267,6 @@ Once logged in, you'll be able to install private packages that those users have
 
 ### `auth` Functions
 
-<br />
-
 ### ▸ `init`
 
 Intialize the authentication for use in WebContainer. This method should be called as soon as possible as part of the loading phase of your page. For example at the top of a module that gets loaded as soon as the page loads. This is important for multiple reasons:
@@ -851,6 +851,7 @@ Options that control spawning a process.
 
 ```ts
 export interface SpawnOptions {
+  cwd?: string;
   env?: Record<string, string | number | boolean>;
   output?: boolean;
   terminal?: { cols: number; rows: number };
@@ -861,6 +862,14 @@ export interface SpawnOptions {
 
 <br />
 
+#### ▸ `cwd?: string`
+
+Current working directory for the process, relative to [`workdir`](#workdir-string) this instance (which you can change when [booting `WebContainer`](#▸-boot)).
+
+By default, the working directory of the spawned process is [`workdir`](#workdir-string).
+
+<br />
+
 #### ▸ `env?: Record<string, string | number | boolean>`
 
 Environment variables to set for the process.

docs/changelog.md

@@ -10,6 +10,11 @@ head:
 
 # Changelog
 
+## 1.2.0
+
+* Add support for [`authentication`](api#auth).
+* add [`cwd`](api#▸-cwd-string) option to [`SpawnOptions`](api#spawnoptions).
+
 ## 1.1.8
 
 * Add [`fs.watch`](api#▸-watch).