Skip to content

Commit 2c42a21

Browse files
committed
Update JS class description
1 parent 8c6931d commit 2c42a21

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

js/src/sandbox.ts

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,25 @@ export interface CreateCodeContextOpts {
8787
}
8888

8989
/**
90-
* Extension for Sandbox that allows executing code with a stateful context.
90+
* E2B cloud sandbox is a secure and isolated cloud environment.
91+
*
92+
* The sandbox allows you to:
93+
* - Access Linux OS
94+
* - Create, list, and delete files and directories
95+
* - Run commands
96+
* - Run isolated code
97+
* - Access the internet
98+
*
99+
* Check docs [here](https://e2b.dev/docs).
100+
*
101+
* Use {@link Sandbox.create} to create a new sandbox.
102+
*
103+
* @example
104+
* ```ts
105+
* import { Sandbox } from '@e2b/code-interpreter'
106+
*
107+
* const sandbox = await Sandbox.create()
108+
* ```
91109
*/
92110
export class Sandbox extends BaseSandbox {
93111
protected static override readonly defaultTemplate: string = 'code-interpreter-v1'

0 commit comments

Comments
 (0)