Skip to content

Docs/SSE: Add node version #5219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 4, 2020
Merged

Docs/SSE: Add node version #5219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions packages/homepage/content/docs/3-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ support these options:

| Option | Description | Possible Values | Default Value |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `infiniteLoopProtection` | Whether we should throw an error if we detect an infinite loop | `true`/`false` | `true` |
| `hardReloadOnChange` | Whether we should refresh the sandbox page on every change, good for sandboxes with global state | `true`/`false` | `false` |
| `template` | Which sandbox template to use | [see here](https://github.com/codesandbox/codesandbox-importers/blob/master/packages/types/index.d.ts#L34-L59) | smart detection, w/ fallback to `create-react-app` |
| `view` | Which view to show first in the preview | Client: `browser`/`console`/`problems`/`tests`<br />Container: `browser`/`console`/`problems`/`terminal` | `browser` |
| `disableLogging` | Whether we should disable in-browser logging and have all logs created by the sandbox go to the browser console | `true`/`false` | `false` |
| `container` | The container object contains the configurable port and/or startScript option, for example: `container: { port: 3212, startScript: "custom"}` |
| `infiniteLoopProtection` | Whether we should throw an error if we detect an infinite loop | `true` / `false` | `true` |
| `hardReloadOnChange` | Whether we should refresh the sandbox page on every change, good for sandboxes with global state | `true` / `false` | `false` |
| `template` | Which sandbox template to use | [see here](https://github.com/codesandbox/codesandbox-importers/blob/master/packages/types/index.d.ts#L34-L59) | smart detection, w/ fallback to `"create-react-app"` |
| `view` | Which view to show first in the preview | Client: `"browser"` / `"console"` / `"problems"` / `"tests"`<br />Container: `"browser"` / `"console"` / `"problems"` / `"terminal"` | `"browser"` |
| `disableLogging` | Whether we should disable in-browser logging and have all logs created by the sandbox go to the browser console | `true` / `false` | `false` |
| `container` | The container object contains the port, start script and Node.js major version, for example: `"container": { "port": 3212, "startScript": "custom", "node": "14" }` |
| `port` | The main port which the browser window listens to | 1024 - 65535 | First opened port inside the container. |
| `startScript` | Explicitly specify the start script used in a container sandbox, overriding the default value | A String matching a script name defined under `scripts` in `package.json` | `dev` / `develop` / `serve` / `start` |
| `startScript` | Explicitly specify the start script used in a container sandbox, overriding the default value | A String matching a script name defined under `"scripts"` in `package.json` | `"dev"` / `"develop"` / `"serve"` / `"start"` |
| `node` | The Node.js major version to use inside the container. The exact versions used are as follows:<br />`"10"`: `10.23.0`<br />`"12"`: `12.20.0`<br />`"14"`: `14.15.1` | `"10"` / `"12"` / `"14"` | `"10"` |