# ks-route-parser

> A Nodejs YML route parser

Latest version **0.0.1** (published 2016-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install ks-route-parser
pnpm add ks-route-parser
yarn add ks-route-parser
bun add ks-route-parser
```

## 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.1 |
| Published | 2016-07-26 |
| First published | 2016-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marvin Frachet |
| Maintainers | skahrz |

## Links

- npm: https://www.npmjs.com/package/ks-route-parser
- Repository: https://github.com/Skahrz/route-parser
- Issues: https://github.com/Skahrz/route-parser/issues
- npm.io page: https://npm.io/package/ks-route-parser

## Dependencies (1)

- [js-yaml](https://npm.io/package/js-yaml.md) ^3.6.1

## Recent versions

- 0.0.1 (latest) — 2016-07-26

## README

<p>
  <a href="https://travis-ci.org/Skahrz/route-parser"><img src="https://travis-ci.org/Skahrz/route-parser.svg?branch=master"/></a>
  <a href='https://coveralls.io/github/Skahrz/route-parser?branch=master'><img src='https://coveralls.io/repos/github/Skahrz/route-parser/badge.svg?branch=master' alt='Coverage Status' /></a>
  <img src="https://camo.githubusercontent.com/3b4ab215354d288be2f370236004672682b54a7e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d6d69742d626c75652e737667" data-canonical-src="https://img.shields.io/badge/license-mit-blue.svg">
</p>

# Route parser

It a simple route parser accepting a list of YML files and return a list of resolved routes like :

```yaml
home:
  pattern: '/home'
  post:
    controller: 'ControllerMock:add'
    middlewares: [
      controller: 'Auth:isAuth'
    ]
```

And creates a new instance of :

```javascript
/**
 * The route definition class
 */
export default class Route {

  /**
   * Create a new route
   * @param  {string} pattern            The pattern URL
   * @param  {string} method             The HTTP method
   * @param  {Object} controllerInstance The controller instance object
   * @param  {string} controllerMethod   The controller method
   * @param  {Object[]} middlewares = [] The middleware list to start before the route is resolved
   */
  constructor (pattern, method, controller, controllerMethod, middlewares = []) {
    /**
     * The pattern URL
     * @type {string}
     */
    this.pattern = pattern
    /**
     * The HTTP method
     * @type {string}
     */
    this.method = method
    /**
     * The controller object
     * @type {Object}
     */
    this.controller = controller
    /**
     * The controller method
     * @type {string}
     */
    this.controllerMethod = controllerMethod
    /**
     * The middleware list to start before the route is resolved
     * @type {Object[]}
     */
    this.middlewares = middlewares
  }

}

```

# Usage

You can simply call this :

```javascript
import RouteParser from 'route-parser'

/**
 * Create a new route parser
 */
const routeParser = new RouteParser()
/**
 * Get a list of YML files to parse
 * Returns the route parsed with the above model
 */
const routes = routeParser.parseRoutes(['path/to/file/routes.yml'])
```

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