Hot Reload

TypeServe watches your files and automatically reloads the server when changes are detected. No manual restarts needed!

What Triggers Reload

TypeServe automatically reloads when:

Configuration changes - When typeserve.config.ts is modified
Type changes - When any TypeScript type used in your config changes
Related files - When files that contain your types are modified

How It Works

When you save a file, TypeServe detects the change and:

Stops the current server
Reloads the configuration
Re-parses your types (this may take a moment depending on project size)
Restarts the server with updated routes

You'll see output like:

🔄 File changed: src/types.ts
🔄 Reloading server...
📖 Parsing types...
✅ Types parsed in 37.5s
🚀 Attempting to start your server on port 7002...
✅ TypeServe running on http://localhost:7002/api (started in 37.5s)
📋 Available routes:
   GET /api/users → User[]
✅ Server reloaded in 1m 12.3s

The parsing step ensures all type changes are properly reflected in the generated mock data.

Example Workflow

1. Start the Server

npx typeserve dev

📖 Loading configuration...
✅ Configuration loaded successfully
📖 Parsing types...
   This may take a while depending on the number of types and project size (est 7.0s).
✅ Types parsed in 1m 1.1s
🚀 Attempting to start your server on port 7002...
✅ TypeServe running on http://localhost:7002/api (started in 1m 1.5s)
📋 Available routes:
   GET /api/users → User

2. Modify a Type

// src/types.ts
export interface User {
  id: string;
  email: string;
  name: string;
  age: number; // ← Add this field
  isActive: boolean; // ← Add this field
}

3. Save the File

TypeServe automatically detects the change:

🔄 File changed: src/types.ts
🔄 Reloading server...
📖 Parsing types...
✅ Types parsed in 37.5s
🚀 Attempting to start your server on port 7002...
✅ TypeServe running on http://localhost:7002/api (started in 37.5s)
📋 Available routes:
   GET /api/users → User[]
✅ Server reloaded in 1m 12.3s

4. Test the Updated API

curl http://localhost:7002/api/users

The response now includes the new fields:

[
  {
    "id": "...",
    "email": "...",
    "name": "...",
    "age": 28, // ← New field
    "isActive": true // ← New field
  }
]

Adding New Routes

When you add a new route to your config:

export default defineMock({
  routes: [
    { path: '/users', method: 'GET', type: 'User[]' },
    { path: '/posts', method: 'GET', type: 'Post[]' }, // ← New route
  ],
});

The server reloads and the new route is immediately available:

🔄 File changed: src/typeserve.config.ts
🔄 Reloading server...
📖 Parsing types...
✅ Types parsed in 37.5s
🚀 Attempting to start your server on port 7002...
✅ TypeServe running on http://localhost:7002/api (started in 37.5s)
📋 Available routes:
   GET /api/users → User[]
✅ Server reloaded in 1m 12.3s
   GET /api/posts → Post[]  ← New route