https://github.com/stone-foundation/stone-js-router
Universal router for modern JavaScript and TypeScript apps. Works seamlessly across Node.js and browser environments. Built for serverless, SSR, and SPA with a functional, composable API.
https://github.com/stone-foundation/stone-js-router
context-aware csr javascript js-router official-stonejs spa ssr stone-foundation stonejs ts-route typescript
Last synced: 11 months ago
JSON representation
Universal router for modern JavaScript and TypeScript apps. Works seamlessly across Node.js and browser environments. Built for serverless, SSR, and SPA with a functional, composable API.
- Host: GitHub
- URL: https://github.com/stone-foundation/stone-js-router
- Owner: stone-foundation
- License: apache-2.0
- Created: 2023-08-25T05:38:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-12T05:33:37.000Z (about 1 year ago)
- Last Synced: 2025-06-12T05:36:49.350Z (about 1 year ago)
- Topics: context-aware, csr, javascript, js-router, official-stonejs, spa, ssr, stone-foundation, stonejs, ts-route, typescript
- Language: TypeScript
- Homepage: https://stonejs.dev
- Size: 362 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Stone.js - Router
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/@stone-js/router)
[](https://www.npmjs.com/package/@stone-js/router)
[](https://github.com/stone-foundation/stone-js-router/actions/workflows/main.yml)
[](https://github.com/stone-foundation/stone-js-router/actions/workflows/release.yml)
[](https://sonarcloud.io/summary/new_code?id=stone-foundation_stone-js-router)
[](https://sonarcloud.io/summary/new_code?id=stone-foundation_stone-js-router)
[](./SECURITY.md)
[](https://github.com/stone-foundation/stone-js-router/security/code-scanning)
[](https://github.com/stone-foundation/stone-js-router/network/updates)
[](https://conventionalcommits.org)
Stone.js router for both Node.js and browser environments, designed for serverless applications.
---
## Overview
**Stone Router** is a high-performance, universal router designed to work seamlessly across **Node.js** and **browser environments**. As a core part of the [Stone.js](https://stonejs.dev) framework, it enables robust, declarative, and composable route handling for **serverless**, **SSR**, and **SPA** applications.
## Key Features
- **Universal**: Works on both backend and frontend (Node.js, browsers, SSR apps).
- **Composable**: Supports route builders, chaining, and nested route structures.
- **Context-Aware**: Routes are designed to respond to the execution context.
- **Type-Safe & Declarative**: Built with TypeScript-first principles.
- **Fast & Lightweight**: Optimized for high-performance and minimal overhead.
- **Model Binding**: Automatically inject models and bindings into routes.
- **Flexible Middleware System**: Apply middleware globally or per route.
- **Regex and Dynamic Params**: Advanced matching for custom use cases.
- **Error Handling & Fallbacks**: Integrated with the event lifecycle.
- **Smart Defaults**: Supports defaults, route rules, redirect handling, etc.
## Installation
```bash
npm install @stone-js/router
```
> [!IMPORTANT]
> This package is **pure ESM**. Ensure your `package.json` includes `"type": "module"` or configure your bundler appropriately.
## Usage
Stone Router exposes a functional/declarative API that allows defining, composing, and dispatching routes easily.
It is designed to be used in both server and client contexts, making it ideal for modern web applications that require a unified routing solution.
It fully integrates with the **event system** of Stone.js through `IncomingEvent` and `OutgoingResponse`.
```ts
import { IncomingEvent } from '@stone-js/core'
import { defineRoutes } from '@stone-js/router'
export const routes = defineRoutes([
{
method: 'GET',
path: '/users/:id',
handler: async (event: IncomingEvent) => {
return { body: `User ID: ${event.get('id') }` }
}
}
])
```
## Learn More
This package is part of the Stone.js ecosystem, a modern JavaScript framework built around the Continuum Architecture.
Explore the full documentation: https://stonejs.dev
## API documentation
* [API](https://github.com/stone-foundation/stone-js-router/blob/main/docs)
## Contributing
See [Contributing Guide](https://github.com/stone-foundation/stone-js-router/blob/main/CONTRIBUTING.md)