# gengojs-default-router

> The default router plugin for gengo.js

Latest version **0.0.6** (published 2015-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install gengojs-default-router
pnpm add gengojs-default-router
yarn add gengojs-default-router
bun add gengojs-default-router
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2015-10-09 |
| First published | 2015-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | iwatakeshi |
| Maintainers | iwatakeshi |

## Links

- npm: https://www.npmjs.com/package/gengojs-default-router
- Repository: https://github.com/gengojs/plugin-router
- Issues: https://github.com/gengojs/plugin-router/issues
- npm.io page: https://npm.io/package/gengojs-default-router

## Dependencies (4)

- [cldr](https://npm.io/package/cldr.md) ^3.2.0
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [gengojs-debug](https://npm.io/package/gengojs-debug.md) ^2.0.4

## Recent versions

- 0.0.6 (latest) — 2015-10-09
- 0.0.5 — 2015-10-05
- 0.0.4 — 2015-10-03
- 0.0.3 — 2015-10-03
- 0.0.2 — 2015-08-23
- 0.0.1-beta.8 — 2015-04-22
- 0.0.1-beta.7 — 2015-04-19
- 0.0.1-beta.6 — 2015-04-13
- 0.0.1-beta.5 — 2015-04-13
- 0.0.1-beta.4 — 2015-04-09
- 0.0.1-beta.3 — 2015-04-09
- 0.0.1-beta.2 — 2015-04-09
- 0.0.1-beta.1 — 2015-04-08

## README

# gengojs-default-router

The default router plugin for gengo.js.

[![Build Status](https://travis-ci.org/gengojs/plugin-router.svg?branch=master)](https://travis-ci.org/gengojs/plugin-router)

An example usage with options is:

```js

var gengo = require('gengojs');
var router = require('gengojs-default-router');

/* In whatever framework you are using: */

// I'll use express for an example
// but it shouldn't matter

var app = require('express')();
app.use(gengo({
   // Specify the type
   // of option to modify
	router:{
		/* options */
	}
},/*router()*/));
```


## Options

```json
{
	"enabled":false
}
```
## Internal API

* `this.router.toArray()`
	* Should return the URL path as an array.
* `this.router.toDot()`
	* Should return the URL path as an dotted string.
* `this.router.isEnabled()`
	* Should return true if router is enabled.

## Dependencies

Not Applicable

## Debug

Unix:

```bash
DEBUG=gengo.router
```
Windows:

```bash
SET DEBUG=gengo.router
```

See [gengojs-debug](https://github.com/gengojs/gengojs-debug) for usage.

## Contribute

Feel free to contribute or even fork the project.
This plugin has been written in ES6 and can be seen under lib/index.js.

---
_Source: https://npm.io/package/gengojs-default-router · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._