Skip to content

配置选项参考

routes

  • 类型RouteConfig | Array<RouteConfig | string> | string
    • RouteConfig | Array<RouteConfig | string> - 需要添加到开发服务器的初始模拟路由列表。
    • string - 指定定义模拟路由的目录路径。
  • 必填false

routerOptions

  • 类型SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2>
  • 必填false

cwd

  • 类型string
  • 必填false
  • 默认值process.cwd()
    当前工作目录。

isAfter

  • 类型boolean
  • 必填false
    • 如果设为 true,这些模拟路由将在内部中间件安装完成后才进行匹配。

TypeScript 类型定义

typescript
import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';

export interface HandleRoute {
  file?: string;
  handler?: any | Handler<HTTPVersion.V1>;
  options?: RouteOptions;
  store?: any;
}

export interface RouteConfig {
  [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
}

export interface Options {
  /**
   * 需要提供文件的目录路径。
   * @default `process.cwd()`
   */
  cwd?: string;

  /**
   * 如果设为 `true`,这些模拟路由将在内部中间件安装完成后匹配。
   * @default `false`
   */
  isAfter?: boolean;

  /**
   * `find-my-way` 的初始配置选项。[详情见文档](https://github.com/delvedor/find-my-way#findmywayoptions)
   */
  routerOptions?: SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2>;

  /**
   * 需要添加到开发服务器的初始模拟路由列表,
   * 或指定定义模拟路由的目录路径。
   */
  routes?: RouteConfig | Array<RouteConfig | string> | string;
}