yyl-server v0.3.23

yyl-server

install

npm i yyl-server --save-dev

api

/// <reference types="@types/connect" />

import createServer = require("connect");

type Log = (type: string, args: any[]) => any;
type AnyObj = { [key:string]: any};
type App = createServer.Server

interface Commit {
  hostname?: string;
  /** 静态资源域名，若没有则会取 hostname */
  staticHost?: string;
  /** html域名，若没有则会取 hostname */
  mainHost?: string;
}



interface ServerConfig {
  /** 端口 */
  port?: number;
  /** 映射目录 */
  root?: string;
  /** 热更新 port */
  lrPort?: number;
  /** 是否执行livereload */
  livereload?: boolean;
  /** 服务地址 */
  serverAddress?: string,
  /** mock 根目录 */
  mockRoot?: string;
}

interface ProxyConfig {
  /** 代理端口 */
  port?: number;
  /** 映射表 */
  localRemote?: anyObj,
  /** 是否执行 https */
  https?: boolean,
  /** 主页 */
  homePage?: string,
  /** 跳过规则 */
  ignores?: string[]
}

/** yy.config.js 中用到的配置项 */
interface YylConfig {
  /** 本地服务 配置 */
  localserver: ServerConfig,
  /** 代理服务 配置 */
  proxy: ProxyConfig,
  /** 远程配置 */
  commit: Commit
}

interface ServerOption {
  /** connect 对象绑定 第三方 */
  appWillMounted?: (app: App) => Promise<any>
  appDidMounted?: (app: App) => Promise<any>
}

/** server 相关 */
declare class Server {
  constructor({ log: Tlog, env: anyObj, config: ServerConfig, cwd: string, option: ServerOption })
  /** 启动 */
  start(): Promise<any>;
  /** 停止 - 一般用于 unit-test */
  abort(): Promise<any>;
  /** 主动热更新 */
  livereload(): Promise<any>;
  /** 初始化后的配置 */
  config: ServerConfig;
  /** express or connect 对象 */
  app: App;
  /** server 对象 */
  server: any;
  /** 热更新服务对象 */
  lrServer: any;
  option: ServerOption;
}

/** 代理相关 */
declare class Proxy {
  constructor({ log: Tlog, env: AnyObj, config: ProxyConfig})
  /** 清除 本地缓存 */
  static clean(): Promise<any>;
  /** 启动 */
  start(): Promise<any>;
  /** 停止 */
  abort(): Promise<any>;
}

/** 执行者 包含 server & proxy */
declare class Runner {
  /** 清除 本地缓存 */
  static clean(): Promise<any>;
  constructor({ log: Log, env: AnyObj, config: YylConfig, cwd: string, serverOption: ServerOption })
  /** 启动 */
  start(): Promise<any>;
  /** 停止 */
  abort(): Promise<any>;
  /** 触发热更新 */
  livereload(): Promise<any>;
}

export {
  Server,
  Proxy,
  Runner
}