# sails-hook-routefactory

> a hook to provide laravel-like route generation sugar

Latest version **1.0.3** (published 2016-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install sails-hook-routefactory
pnpm add sails-hook-routefactory
yarn add sails-hook-routefactory
bun add sails-hook-routefactory
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-03-17 |
| First published | 2016-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Danny Hadley |
| Maintainers | dadleyy |

## Links

- npm: https://www.npmjs.com/package/sails-hook-routefactory
- Repository: https://github.com/dadleyy/sails-hook-routefactory
- Issues: https://github.com/dadleyy/sails-hook-routefactory/issues
- npm.io page: https://npm.io/package/sails-hook-routefactory

## Recent versions

- 1.0.3 (latest) — 2016-03-17
- 0.0.1 — 2016-03-15

## README

# sails-hook-routefactory 

[![Build Status](https://travis-ci.org/dadleyy/sails-hook-routefactory.svg?branch=master)](https://travis-ci.org/dadleyy/sails-hook-routefactory) [![codecov.io](https://codecov.io/github/dadleyy/sails-hook-routefactory/coverage.svg?branch=master)](https://codecov.io/github/dadleyy/sails-hook-routefactory?branch=master)


A [sailsjs](http://sailsjs.org/) hook that allows a function under `sails.config.routefactory` to behave like [laravel's](https://laravel.com/docs/5.2/routing) routing engine.


### Installation

Installing custom hooks for a sailsjs application is done by installing their npm module as a dependency of the application. Sails picks up these special packages by looking for those modules having a `sails.isHook` property set to `true`. So, to start using this hook, just run

```
npm i sails-hook-routefactory --save
```

### Useage

The hook uses the `sails.config.routefactory` property, which can be set by creating a file underneath your application's `config` directory called `routefactory.js`. This file should look like this:


```javascript
module.exports.routefactory = function(factory) {

  factory.resource('user', 'UserController');

  factory.group('admin', function() {
    factory.get('/info', 'SystemController.diagnostics');

    factory.resource('/settings', 'SystemController', {except: ['findOne', 'destroy']});
  });

  factory.route('POST /logger', 'LoggerController.create');

};
```

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