beidou-router

2.0.1 • Public • Published

Beidou Router

Auto Router for Beidou framework

Install

$ npm install beidou-router --save

Configuration

  • config/plugin.js:
exports.router = {
  enable: true,
  package: 'beidou-router',
};
  • config/config.default.js
/**
 * Router options
 * @member Config#router
 */
exports.router = {
  /**
   * root directory for auto match route
   * include server route and webpack entry
   * @member {String} Config#root
   * @since 1.0.0
   */
  root: '/',

  /**
   * files or directories should be ignored
   * when automatically match route
   * @member {String} Config#exclude
   * @since 1.0.0
   */
  exclude: '_*',

  /**
   * define custom mapping files to router
   *
   * {
   *  user: {
   *    profile: 'get',
   *    ':id': ['post', 'get'],
   *  }
   * }
   *
   */
  mapping: null,

  entry: 'index',
};

Usage

Straightly visit page located in client directory.

e.g. with default config, access GET: / will render client/index.jsx file.

API

coming soon

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i beidou-router

Weekly Downloads

1

Version

2.0.1

License

MIT

Unpacked Size

8.26 kB

Total Files

9

Last publish

Collaborators

  • devrsi0n
  • njugray