Examples

Quickstart Example Catalog

playwright-basic.ts

• Create a normal browser session
• Connect with Playwright over CDP
• Visit https://example.com
• Print the page title

session-management.ts

• Create normal and light sessions
• List active sessions
• Print pagination and session metadata

context-basic.ts

• Create a persistent context
• Attach it to a session
• Reuse the same context across runs

context-list-get.ts

• List available contexts
• Fetch one context by ID
• Inspect metadata and lock status

context-modes.ts

• Demonstrate readWrite and readOnly context access
• Show how the SDK normalizes context mode values

context-lock-handling.ts

• Demonstrate handling ContextLockedError
• Show retry metadata such as activeSessionId and retryAfter

extension-basic.ts

• Upload an extension zip archive
• List uploaded extensions
• Create a browser session with extensionIds

proxy-session.ts

• Create a browser session with upstream proxy configuration
• Verify the remote browser can use authenticated proxy settings

session-downloads.ts

• Configure Browser.setDownloadBehavior to /config/Downloads
• Trigger a file download in the remote browser
• Query download metadata through the SDK
• Fetch a single file or archive all downloads

Run The Examples

# 1. Install SDK dependencies and build
npm install
npm run build

# 2. Configure environment variables in repository root
cp .env.example .env
# Fill in your actual API Key and Project ID

# 3. Install example dependencies
cd examples
npm install

# 4. Run scripts
npm run playwright-basic
npm run session-management
npm run context-basic
npm run context-list-get
npm run context-modes
npm run context-lock-handling
npm run extension-basic
npm run proxy-session
npm run session-downloads

Environment Variables Used By Examples

LEXMOUNT_API_KEY=your-api-key
LEXMOUNT_PROJECT_ID=your-project-id
LEXMOUNT_BASE_URL=https://api.lexmount.cn
LEXMOUNT_EXTENSION_PATH=/absolute/path/to/extension.zip
LEXMOUNT_PROXY_SERVER=http://host:port
LEXMOUNT_PROXY_USERNAME=optional
LEXMOUNT_PROXY_PASSWORD=optional

Example Source Files

• examples/playwright-basic.ts for the minimal browser connection flow.
• examples/session-management.ts for session creation and pagination.
• examples/context-basic.ts for persistent context attachment.
• examples/context-list-get.ts for context listing and inspection.
• examples/context-modes.ts for read-write and read-only access modes.
• examples/context-lock-handling.ts for lock conflict handling.
• examples/extension-basic.ts for extension upload and mount.
• examples/proxy-session.ts for upstream proxy configuration.
• examples/session-downloads.ts for remote download retrieval.