Skip to content

Commit 3785ffc

Browse files
wording on auto-resume
1 parent 61c8978 commit 3785ffc

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/sandbox/auto-resume.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Behavior and limits may change as we iterate. Review [Sandbox persistence limita
1111

1212
Many workloads don't need a sandbox running all the time, but when they do need it, it should just work, whether it was paused or not.
1313

14-
`AutoResume` handles this automatically: a paused sandbox wakes up when traffic arrives, so your code never has to check or manage sandbox state.
14+
`AutoResume` handles this automatically: a paused sandbox wakes up when activity arrives, so your code does not have to check or manage sandbox state.
1515
Configure it through the `lifecycle` object when creating a sandbox.
1616

1717
## Configure lifecycle on create
@@ -48,14 +48,15 @@ sandbox = Sandbox.create(
4848
- `pause`: sandbox is paused when timeout is reached
4949
- `autoResume` / `auto_resume`
5050
- `false` (default): paused sandboxes do not auto-resume
51-
- `true`: paused sandboxes auto-resume on traffic
51+
- `true`: paused sandboxes auto-resume on activity
5252
- `true` is valid only when `onTimeout`/`on_timeout` is `pause`
5353

5454
## Behavior summary
5555

5656
- Default behavior is equivalent to `onTimeout: "kill"` with `autoResume: false`.
5757
- `onTimeout: "pause"` with `autoResume: false` gives auto-pause without auto-resume.
5858
- `onTimeout: "pause"` with `autoResume: true` gives auto-pause with auto-resume.
59+
- [`Sandbox.connect()`](/docs/sandbox/connect) can still be used to resume a paused sandbox manually.
5960

6061
If you use `autoResume: false`, resume explicitly with [`Sandbox.connect()`](/docs/sandbox/connect).
6162

0 commit comments

Comments
 (0)