Server Communication

Core RPC communication functions for DevTools server connectivity, health monitoring, and project configuration access.

Capabilities

Health Check

Simple heartbeat function to verify server connectivity and RPC communication.

/**
 * Simple heartbeat function for server connectivity verification
 * @returns Always returns true to confirm server is responsive
 */
function heartbeat(): boolean;

Usage Example:

// Verify server connection
const isAlive = heartbeat();
console.log('Server responsive:', isAlive); // Always true if connection works

Project Configuration

Access to core project configuration information.

/**
 * Gets the project root directory path
 * @returns Project root directory as absolute path
 */
function getRoot(): string;

Usage Example:

const projectRoot = getRoot();
console.log('Project root:', projectRoot);
// Result: "/Users/developer/my-vue-project"

RPC Infrastructure

These functions are part of the RPC (Remote Procedure Call) system that enables communication between the DevTools client and the Vite development server.

Communication Flow

1. Client Request: DevTools client calls RPC function
2. Server Processing: Vite plugin processes the request
3. Response: Server returns result to client
4. Real-time Updates: Server can broadcast updates to all connected clients

Error Handling

RPC functions handle common error scenarios:

• Connection Issues: Functions will throw if server is unreachable
• Invalid Parameters: Type validation ensures proper parameter handling
• Server Errors: Internal server errors are properly propagated to client

Integration with Other Functions

Server communication functions work alongside other DevTools capabilities:

• Asset Analysis: Uses server filesystem access for asset scanning
• Module Graph: Leverages Vite's internal module tracking
• Component Inspector: Coordinates with development server for file editing