feat: custom matcher and improved docs

README.md

@@ -13,7 +13,8 @@
 - Tree-shakable and zero dependency
 - Promise and `aync/await` support
 - Lazy Loading
-- Basic Router
+- Quick prefix router
+- Custom route matcher
 
 > See [un](https://github.com/nuxt-contrib/un) for workers support
 
@@ -33,10 +34,20 @@ const { createApp } = require('@nuxt/h2')
 
 const app = createApp()
 
+// Handle can directly return object or Promise<object> for JSON response
 app.use('/api', (req) => ({ url: req.url }))
-app.use(() => 'Hello world!')
 
+// You can have better matching other than quick prefix match
+app.use('/odd', () => 'Is odd!', { match: url => url.substr(1) % 2 })
+
+// Handle can directly return string for HTML response
+app.use(() => '<h1>Hello world!</h1>')
+
+// If handle is already async, using useAsync to avoid unnecessary promisify wrapper
+// (Shrotcut to pass { proimsify: false })
 // app.useAsync(async () => {})
+
+// Lazy loading routes using { lazy: true }
 // app.use('/big', () => import('./big'), { lazy: true })
 
 const port = process.env.PORT || 3000

package.json

@@ -22,6 +22,7 @@
     "eslint": "latest",
     "express": "^4.17.1",
     "jest": "^26.6.3",
+    "jiti": "^0.1.12",
     "siroc": "latest",
     "standard-version": "latest",
     "ts-jest": "^26.4.4",

src/app.ts

@@ -48,6 +48,7 @@ export function use (
 
 export function createHandle (stack: Stack): PHandle {
   return async function handle (req: IncomingMessage, res: ServerResponse) {
+    req.url = req.url || '/'
     const originalUrl = (req as any).originalUrl = (req as any).originalUrl || req.url || '/'
     for (const layer of stack) {
       if (layer.route.length) {
@@ -56,6 +57,9 @@ export function createHandle (stack: Stack): PHandle {
         }
         req.url = originalUrl.substr(layer.route.length) || '/'
       }
+      if (layer.match && !layer.match(req.url as string, req)) {
+        continue
+      }
       const val = await layer.handle(req, res)
       if (res.writableEnded) {
         break
@@ -78,6 +82,7 @@ export function createHandle (stack: Stack): PHandle {
 function normalizeLayer (layer: InputLayer) {
   return {
     route: stripTrailingSlash(layer.route).toLocaleLowerCase(),
+    match: layer.match,
     handle: layer.lazy
       ? lazyHandle(layer.handle as LazyHandle, layer.promisify)
       : (layer.promisify !== false ? promisifyHandle(layer.handle) : layer.handle)

src/types.ts

@@ -6,8 +6,11 @@ export type PHandle = (req: IncomingMessage, res: ServerResponse) => Promise<any
 
 export type Middleware = (req: IncomingMessage, res: ServerResponse, next: (err?: Error) => any) => any
 
+export type Matcher = (url: string, req?: IncomingMessage) => Boolean
+
 export interface Layer {
   route: string
+  match?: Matcher
   handle: Handle
 }
 
@@ -17,6 +20,7 @@ export type LazyHandle = () => Handle | Promise<Handle>
 
 export interface InputLayer {
   route?: string
+  match?: Matcher
   handle: Handle | LazyHandle
   lazy?: boolean
   promisify?: boolean

test/fixture/server.js

@@ -1,6 +1,6 @@
 const { Server } = require('http')
 const express = require('express')
-const { createApp } = require('../..')
+const { createApp } = require('jiti')(__dirname)('../../src')
 
 function createExpress () {
   const app = express()
@@ -15,6 +15,7 @@ const app = createApp()
 app.use('/api/hello', req => ({ url: req.url }))
 app.use('/api/express', createExpress())
 app.use('/api', (_req, res) => { res.end('API root') })
+app.use('/odd', () => 'Is odd!', { match: url => url.substr(1) % 2 })
 app.use('/', () => 'Hello world!')
 
 const port = process.env.PORT || 3000

yarn.lock

@@ -3742,7 +3742,7 @@ jest@^26.6.3:
     import-local "^3.0.2"
     jest-cli "^26.6.3"
 
-jiti@^0.1.11:
+jiti@^0.1.11, jiti@^0.1.12:
   version "0.1.12"
   resolved "https://registry.yarnpkg.com/jiti/-/jiti-0.1.12.tgz#ffe4a09266d739b77721170fb73115c50b680330"
   integrity sha512-rWtqsaABBGNzTzfQkfP7DUvE9KGEIQUd6s0nITw5rDW1L9OwwtBQ5dz9hMq4YrMZqrSJr8ArrMvZ1mV1/7S3Fg==