leviroutes - GitLite

KO | EN

gitlite — search

#vue #web #typescript #kubernetes #open-source #react-native #ai #github #cloud-native #dotnet

leviroutes

(★ 241)

A basic routes framework for JS that hooks in to HTML5 history

File Explorer

ZIP Download

- copilot-instructions.md
- - middleware-example.html
- index.html
- README.md
- - jasmine-html.js
  - jasmine.css
  - jasmine.js
  - json2.js
- - dom-helper.mjs
- - jasmine.json
- middleware.spec.mjs
- routeexecution.spec.mjs
- routemanagement.spec.mjs
- routeparsing.spec.mjs
- routesframework.spec.mjs
- routes.js
- middleware.js
- routeexection.js
- routemanagement.js
- routeparsing.js
- routesframework.js
.gitignore
LICENCE
package-lock.json
package.json
README.md
SpecRunner.html

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`next`

View Details ▼

React framework that uses server-side rendering for building optimized web applications.

next dev

Start the current application in development mode:

next dev {{[-p|--port]}} {{port}}

Start the current application and listen on a specific port:

next build

Build the current application optimized for production:

🔍

`npm install`

View Details ▼

Install Node packages.

npm {{[i|install]}}

Install dependencies listed in `package.json`:

npm {{[i|install]}} {{package_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}

Download the latest version of a package and add it to the list of dev dependencies in `package.json`:

🔍

`npm run`

View Details ▼

Run a script.

npm run

List available scripts:

npm run {{script_name}}

Run a script:

npm run {{script_name}} -- {{argument}} {{--option}}

Pass arguments to a script:

🔍

`npm test`

View Details ▼

This command is an alias of `npm run test`.

tldr npm run

View documentation for the original command:

🔍

`script`

View Details ▼

Record all terminal output to a typescript file.

script

Record a new session to a file named `typescript` in the current directory:

exit

Stop recording:

script {{path/to/session.out}}

Record a new session to a custom filepath:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

LeviRoutes
==========

> **⚠️ DISCLAIMER:** This project has not been updated or maintained for a long time. While I might add more features in the future, please do not rely on this project for production use or active development.

A simple lightweight routes framework for hooking in to HTML5 history.  Currently when the system pop's state the route is triggered if matched.

LeviRoutes can also intercept POST requests via forms, the framework will intercept all submits, and naturally let through requests that don't match the path, whilst firing your callback if there is a match

## Installation

Install via npm:

```bash
npm install leviroutes
```

Or use it directly from a CDN with ES modules:

```html
<script type="module">
  import routes from 'https://esm.sh/leviroutes';
  
  const app = new routes();
  // ... use the library
</script>
```

## Usage

### ES Modules (Recommended)

```javascript
import routes from 'leviroutes';

const app = new routes();

app.get("/", function(req) {
  alert("State popped for /");
});
```

### Classic Script Tag

```html
<script type="module">
  import routes from './node_modules/leviroutes/src/routes.js';
  
  const app = new routes();
  // ...
</script>
```

## Features

### Basic Routing

```javascript
const app = new routes();

app.get("/", function(req) {
  alert("State popped for /");
});
```

### Named Parameters

It also has named parameters for route syntax.

```javascript
app.get("/:category", function(req) {
  alert("In " + req.params.category);
});

app.get("/:category.:format", function(req) {
  alert("format: " + req.params.format);
});
```

### POST Request Handling

LeviRoutes can also intercept POST requests via forms, intercept all submits, and naturally let through requests that don't match the path, whilst firing your callback if there is a match.

```javascript
app.post("/:category", function(req) {
  alert("posting form: In Category " + req.params.category);
});
```

## Middleware Support

LeviRoutes supports middleware functions that execute before route handlers. Middleware functions receive the request object and a `next` callback.

```javascript
app.use(function(req, next) {
  console.log("Request to: " + req.url);
  next(); // Call next to continue to the next middleware or route handler
});

app.use(function(req, next) {
  req.timestamp = Date.now();
  next();
});

app.get("/", function(req) {
  alert("Request timestamp: " + req.timestamp);
});
```

Middleware functions are executed in the order they are registered, before any route handler is called.

## Examples

Check out the [examples](examples/) directory for complete working examples demonstrating:

- **GET Routes**: Basic routing with HTML5 History API
- **POST Routes**: Form interception and handling
- **Middleware**: Multiple middleware functions with request processing
- **Named Parameters**: Dynamic route parameters (e.g., `/user/:id`)
- **Complete SPA**: A full single-page application showcasing all features

To run the examples, start a local web server in the project root and navigate to the examples directory.

## Development

### Running Tests

```bash
npm test
```

### Building

The build process creates a minified version in `dist/routes.min.js`:

```bash
npm run build
```

## License

Licensed under the Apache License, Version 2.0. See the [LICENCE](LICENCE) file for details.