Config ​

DefineConfig ​

Create prext.config.js or prext.config.ts to define config.

1. Default

export default {};

module.exports = {};

2. Using defineConfig()

import { defineConfig } from 'prext/config';

export default defineConfig({
  /* config */
});

const { defineConfig } = require('prext/config');

module.exports = defineConfig({
  /* config */
});

Types ​

base ​

• Type: string
• Default: .

Project root directory. (only relative path)

routes ​

• Type: string
• Default: /pages/

Directory where page files are located.

middlewares ​

• Type: Array<Middleware>

Middlewares Array

function example(req, res, next) {
  req.message = 'Hello World';
  next();
}

export default {
  middlewares: [example],
};

port ​

• Type: number
• Default: 5050

Port

handler ​

• Type: HandlerType

Custom Server Handler

Prext({
  handler: (req, res, routes) => {
    // ...
  },
});

esbuild ​

• Type: esbuild.BuildOptions

Esbuild build option.

plugins ​

• Type: Plugin[]

watch ​

• Type: chokidar.WatchOptions

error ​

• Type: (req: IncomingMessage, res: ServerResponse) => void | Promise<void>;

allowAutoMiddlewares ​

• Type: boolean

middlewareDirectory ​

• Type: string