Skip to content

Commit

Permalink
Update JS class description
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentaTomas committed Oct 16, 2024
1 parent 8c6931d commit 2c42a21
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion js/src/sandbox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,25 @@ export interface CreateCodeContextOpts {
}

/**
* Extension for Sandbox that allows executing code with a stateful context.
* E2B cloud sandbox is a secure and isolated cloud environment.
*
* The sandbox allows you to:
* - Access Linux OS
* - Create, list, and delete files and directories
* - Run commands
* - Run isolated code
* - Access the internet
*
* Check docs [here](https://e2b.dev/docs).
*
* Use {@link Sandbox.create} to create a new sandbox.
*
* @example
* ```ts
* import { Sandbox } from '@e2b/code-interpreter'
*
* const sandbox = await Sandbox.create()
* ```
*/
export class Sandbox extends BaseSandbox {
protected static override readonly defaultTemplate: string = 'code-interpreter-v1'
Expand Down

0 comments on commit 2c42a21

Please sign in to comment.