Routing ​

Prext.js automatically generates routes based on your file tree of pages.

.
├─ pages
│  ├─ user
│  │  └─ $id.ts
│  ├─ users.ts
│  └─ index.ts
├─ prext.config.ts
└─ package.json

will be

["/", "/users", "/users/:id"]

More examples:

/pages/index.ts => /
/pages/dashboard.ts => /dashboard
/pages/foo/bar.ts => /foo/bar
/pages/user/$user.ts => /user/:user

Custom Path ​

If you don't like routes based on filename, just export $page!

export const $page = {
  path: '/foo/bar',
};

Route Parameters ​

You can access the current page parameters by req.params.

// pages/user/$id.ts

import { PrextRequest, PrextResponse } from 'prext';

export function get(req: PrextRequest, res: PrextResponse) {
  res.json({ id: req.params.id });
}

Method ​

Exports functions corresponding get, post, delete etc (http verbs)

// get
export function get(req, res) {}
// post
export function post(req, res) {}
// etc...

request ​

Prext Server is based on node:http module.

reference: http.req

req.params ​

Page Parameters.

• type: any
• example: /item/$id => req.params.id

export function get(req, res) {
  res.end(`item: ${req.params.id}!`);
}

req.query ​

Page Querystring.

• type: object
• example: /abc?foo=bar => req.query.foo

response ​

Prext Server is based on node:http module.

reference: http.res

res.json ​

Send json data.

export function get(req, res) {
  res.json({ id: 1 });
}

res.end ​

Send data

export function get(req, res) {
  res.end('Hello World!');
}

res.send ​

Send data

res.setHeader ​

Set header

res.status ​

Set status

• added: 1.0.0-beta.1

export function get(req, res) {
  res.status(200).end('Hello World!');
}

404 page ​

This Feature has been supported since v0.1.0.

You can set 404 page with config.error.

export default defineConfig({
  error(req, res) {
    // ...
  },
});

Parameters in HTML ​

You cannot access the current page parameters. - (#1)