theway
v0.0.3
Published
A tiny (zero dependency) router for browsers & servers
Downloads
33
Maintainers
Readme
The Way
A tiny (zero dependency) isomorphic router for browsers & servers.
- History & Hash based routing for browser
- Server-side (express style) routing (req,res,next) & middleware
- Simple Static file server
- Support for layouts
Install
npm install theway
Usage
// app.js
import Way from 'theway'
import {
loadRoute,
} from 'theway/utils.js'
const router = new Way('/');
export const createApp = (entrypoint, routeBase) => router
.use("/", loadRoute('/path/to/route/home.js', 'home'))
.use(
"/about",
loadRoute('/path/to/route/about.js', 'about'),
)
.use(
"/thing/*?",
loadRoute('/path/to/route/thing.js', 'thing'),
)
.use(
"/compare/:crypto?/:fiat?",
loadRoute('/path/to/route/compare.js', 'compare'),
)
export default createApp
// main.js - browser
import createApp from './app.js'
let app = createApp(
document.querySelector('#app')
)
app.listen();
// server.js
import http from 'node:http'
import { readFileSync } from 'node:fs'
import { readFile, writeFile } from 'node:fs/promises'
import { join, extname } from 'node:path'
import createApp from './app.js'
import {
DOMFaker,
serveStaticFiles,
} from 'theway/server.js'
const BASE = /<base href="([\s\S]+?)" \/>/ig
const routeBase = import.meta?.dirname + '/routes/'
const theWaySrcDir = join(import.meta.dirname, '../../')
const entryPage = readFileSync('./index.html', 'utf8').replace(BASE, '')
const fakeDOM = DOMFaker(`<main id="app"></main>`, entryPage)
const httpServer = http.createServer();
const app = createApp(
fakeDOM,
routeBase,
)
app
.get("/api/users", async ({params}, res, next) => {
try {
let req = await fetch(
'https://dummyjson.com/users?limit=3&select=firstName,age',
{
headers: {
'Content-Type': 'application/json',
},
}
)
if (req.ok) {
let users = await req.text()
if (users) {
console.log('router get /api/users', params, users)
return res.json(users)
}
}
} catch (err) {
next(err)
}
next('failed to retrieve users data')
})
.use(serveStaticFiles(join(import.meta.dirname, '../')))
httpServer.on('request', app.listen);
httpServer.listen(8080, () => {
console.log('Listening on http://127.0.0.1:8080');
});
Special Thanks
Originally forked from NavAid, but with significant changes.