wok-server 0.5.0 → 0.6.0

package/types/mvc/render/index.d.ts

@@ -1,4 +1,4 @@
-export * from './text';
-export * from './json';
-export * from './file';
-export * from './html';
+export * from './text';
+export * from './json';
+export * from './file';
+export * from './html';

package/types/mvc/render/json.d.ts

@@ -1,17 +1,17 @@
-/// <reference types="node" />
-import { ServerResponse } from 'http';
-/**
- * 渲染 json 格式数据.
- * @param response 响应信息
- * @param json json对象
- * @param status 状态码，默认 200
- * @returns
- */
-export declare function renderJson(response: ServerResponse, json: any, status?: number): void;
-/**
- * 渲染错误信息，json 格式
- * @param response
- * @param message
- * @param status
- */
-export declare function renderError(response: ServerResponse, message: string, status?: number): void;
+/// <reference types="node" />
+import { ServerResponse } from 'http';
+/**
+ * 渲染 json 格式数据.
+ * @param response 响应信息
+ * @param json json对象
+ * @param status 状态码，默认 200
+ * @returns
+ */
+export declare function renderJson(response: ServerResponse, json: any, status?: number): void;
+/**
+ * 渲染错误信息，json 格式
+ * @param response
+ * @param message
+ * @param status
+ */
+export declare function renderError(response: ServerResponse, message: string, status?: number): void;

package/types/mvc/render/text.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="node" />
-import { ServerResponse } from 'http';
-/**
- * 渲染 json 格式数据.
- * @param response 响应信息
- * @param text 文本
- * @param status 状态码，默认 200
- * @returns
- */
-export declare function renderText(response: ServerResponse, text: string, status?: number): void;
+/// <reference types="node" />
+import { ServerResponse } from 'http';
+/**
+ * 渲染 json 格式数据.
+ * @param response 响应信息
+ * @param text 文本
+ * @param status 状态码，默认 200
+ * @returns
+ */
+export declare function renderText(response: ServerResponse, text: string, status?: number): void;

package/types/mvc/router.d.ts

@@ -1,11 +1,11 @@
-import { ServerExchange } from './exchange';
-/**
- * 路由控制器函数.
- */
-export interface RouterHandler {
-    (exchange: ServerExchange): Promise<void>;
-}
-/**
- * 路由列表.
- */
-export type Routers = Record<string, RouterHandler>;
+import { ServerExchange } from './exchange';
+/**
+ * 路由控制器函数.
+ */
+export interface RouterHandler {
+    (exchange: ServerExchange): Promise<void>;
+}
+/**
+ * 路由列表.
+ */
+export type Routers = Record<string, RouterHandler>;

package/types/mvc/server.d.ts

@@ -1,90 +1,90 @@
-/// <reference types="node" />
-import { Server } from 'http';
-import { Interceptor } from './interceptor';
-import { Routers } from './router';
-import { ServerStaticRules } from './static';
-/**
- * mvc 服务选项
- */
-export interface WokServerOpts {
-    /**
-     * 路由配置.
-     */
-    routers: Routers;
-    /**
-     * 拦截器，在路由处理前可以做一些额外操作.
-     */
-    interceptors?: Interceptor[];
-    /**
-     * 前置控制器，在服务启动之前，对服务做一些额外的操作。比如可以连接 socket.io 或者一些其它
-     * 支持 nodejs 原生 http 服务的组件.
-     * @param server
-     * @returns
-     */
-    preHandler?: (server: Server<any>) => Promise<void>;
-    /**
-     * 静态资源配置
-     */
-    static?: ServerStaticRules;
-}
-/**
- * web 服务
- */
-export declare class WokServer {
-    private readonly opts;
-    private readonly config;
-    private readonly server;
-    private readonly interceptors;
-    private readonly routers;
-    private readonly defaultRouter?;
-    private readonly staticHandler?;
-    constructor(opts: WokServerOpts);
-    /**
-     * 处理请求，完成拦截器和路由的流程.
-     *
-     * @param req
-     * @param res
-     */
-    private handleRequest;
-    /**
-     * 处理拦截器.
-     * @param idx 当前要执行的拦截器下标
-     * @param exchange 传输对象
-     * @param req
-     * @param res
-     */
-    private handleInterceptor;
-    /**
-     * 处理路由.
-     * @param exchange
-     * @param routers
-     * @param staticSettings
-     * @returns
-     */
-    private handleRouter;
-    /**
-     * 404响应
-     *
-     * @param exchange
-     * @param path
-     */
-    private respond404;
-    /**
-     * 启动
-     */
-    start(): Promise<void>;
-    /**
-     * 获取 ipv4 地址列表
-     * @returns
-     */
-    private getIpv4List;
-    /**
-     * 删除服务器端静态资源缓存
-     * @param path
-     */
-    removeServerStaticCache(path: string): void;
-    /**
-     * 停止
-     */
-    stop(): Promise<void>;
-}
+/// <reference types="node" />
+import { Server } from 'http';
+import { Interceptor } from './interceptor';
+import { Routers } from './router';
+import { ServerStaticRules } from './static';
+/**
+ * mvc 服务选项
+ */
+export interface WokServerOpts {
+    /**
+     * 路由配置.
+     */
+    routers: Routers;
+    /**
+     * 拦截器，在路由处理前可以做一些额外操作.
+     */
+    interceptors?: Interceptor[];
+    /**
+     * 前置控制器，在服务启动之前，对服务做一些额外的操作。比如可以连接 socket.io 或者一些其它
+     * 支持 nodejs 原生 http 服务的组件.
+     * @param server
+     * @returns
+     */
+    preHandler?: (server: Server<any>) => Promise<void>;
+    /**
+     * 静态资源配置
+     */
+    static?: ServerStaticRules;
+}
+/**
+ * web 服务
+ */
+export declare class WokServer {
+    private readonly opts;
+    private readonly config;
+    private readonly server;
+    private readonly interceptors;
+    private readonly routers;
+    private readonly defaultRouter?;
+    private readonly staticHandler?;
+    constructor(opts: WokServerOpts);
+    /**
+     * 处理请求，完成拦截器和路由的流程.
+     *
+     * @param req
+     * @param res
+     */
+    private handleRequest;
+    /**
+     * 处理拦截器.
+     * @param idx 当前要执行的拦截器下标
+     * @param exchange 传输对象
+     * @param req
+     * @param res
+     */
+    private handleInterceptor;
+    /**
+     * 处理路由.
+     * @param exchange
+     * @param routers
+     * @param staticSettings
+     * @returns
+     */
+    private handleRouter;
+    /**
+     * 404响应
+     *
+     * @param exchange
+     * @param path
+     */
+    private respond404;
+    /**
+     * 启动
+     */
+    start(): Promise<void>;
+    /**
+     * 获取 ipv4 地址列表
+     * @returns
+     */
+    private getIpv4List;
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerStaticCache(path: string): void;
+    /**
+     * 停止
+     */
+    stop(): Promise<void>;
+}

package/types/mvc/static/header.d.ts

@@ -1,27 +1,27 @@
-/// <reference types="node" />
-import { IncomingHttpHeaders } from 'http';
-/**
- * 静态资源消息头信息
- */
-export interface StaticHeaders {
-    /**
-     * If-Modified-Since 消息头，测试文件是否在某个时间后修改后
-     */
-    ifModifiedSince?: Date;
-    /**
-     * 文件部分读取
-     */
-    range?: {
-        start: number;
-        end?: number;
-    };
-    /**
-     * 是否接受 gzip 压缩，如果支持则压缩后返回
-     */
-    gzip: boolean;
-}
-/**
- * 解析消息头，返回静态文件处理需要的信息
- * @param headers
- */
-export declare function parseHeaders(headers: IncomingHttpHeaders): StaticHeaders;
+/// <reference types="node" />
+import { IncomingHttpHeaders } from 'http';
+/**
+ * 静态资源消息头信息
+ */
+export interface StaticHeaders {
+    /**
+     * If-Modified-Since 消息头，测试文件是否在某个时间后修改后
+     */
+    ifModifiedSince?: Date;
+    /**
+     * 文件部分读取
+     */
+    range?: {
+        start: number;
+        end?: number;
+    };
+    /**
+     * 是否接受 gzip 压缩，如果支持则压缩后返回
+     */
+    gzip: boolean;
+}
+/**
+ * 解析消息头，返回静态文件处理需要的信息
+ * @param headers
+ */
+export declare function parseHeaders(headers: IncomingHttpHeaders): StaticHeaders;

package/types/mvc/static/index.d.ts

@@ -1,3 +1,3 @@
-export * from './mime-type';
-export * from './header';
-export * from './static-handler';
+export * from './mime-type';
+export * from './header';
+export * from './static-handler';

package/types/mvc/static/mime-type.d.ts

@@ -1,2 +1,2 @@
-export declare const MIME_TYPES: Record<string, string>;
-export declare function decideContentType(fileName: string): string | undefined;
+export declare const MIME_TYPES: Record<string, string>;
+export declare function decideContentType(fileName: string): string | undefined;

package/types/mvc/static/server-cache-config.d.ts

@@ -1,30 +1,30 @@
-/**
- * 服务器缓存配置
- * Server Cache Configuration
- */
-export interface ServerCacheConfig {
-    /**
-     * Enable or disable caching,default is false (disabled)
-     */
-    enable: boolean;
-    /**
-     *  The maximum age of the cache in seconds
-     */
-    maxAge: number;
-    /**
-     * The maximum size of the cache in bytes
-     * or a string representing a number followed by a unit of measure (e.g. 100k, 10m, 1g)
-     */
-    maxSize: number | string;
-    /**
-     * The maximum size of a file in the cache in bytes
-     * or a string representing a number followed by a unit of measure (e.g. 100k, 10m, 1g)
-     */
-    maxFileSize: number | string;
-}
-export declare function parseSize(size: number | string): number;
-/**
- * 获取缓存的配置信息
- * @returns
- */
-export declare function getConfig(): ServerCacheConfig;
+/**
+ * 服务器缓存配置
+ * Server Cache Configuration
+ */
+export interface ServerCacheConfig {
+    /**
+     * Enable or disable caching,default is false (disabled)
+     */
+    enable: boolean;
+    /**
+     *  The maximum age of the cache in seconds
+     */
+    maxAge: number;
+    /**
+     * The maximum size of the cache in bytes
+     * or a string representing a number followed by a unit of measure (e.g. 100k, 10m, 1g)
+     */
+    maxSize: number | string;
+    /**
+     * The maximum size of a file in the cache in bytes
+     * or a string representing a number followed by a unit of measure (e.g. 100k, 10m, 1g)
+     */
+    maxFileSize: number | string;
+}
+export declare function parseSize(size: number | string): number;
+/**
+ * 获取缓存的配置信息
+ * @returns
+ */
+export declare function getConfig(): ServerCacheConfig;

package/types/mvc/static/server-cache.d.ts

@@ -1,76 +1,76 @@
-/// <reference types="node" />
-export interface CacheVal {
-    /**
-     * 文件内容
-     */
-    buffer: Buffer;
-    /**
-     * 媒体类型
-     */
-    mimeType: string;
-    /**
-     * 修改时间
-     */
-    mtime: Date;
-    /**
-     * 客户端缓存时间
-     */
-    cacheAge?: number;
-}
-/**
- * 文件的服务器缓存
- */
-export declare class ServerCache {
-    private readonly opts;
-    /**
-     * 当前的缓存内容大小，单位字节
-     */
-    private size;
-    /**
-     * 缓存内容
-     */
-    private readonly cacheMap;
-    /**
-     * promise 表，作用是处理异步并发问题，如果有相同的 key 同时请求，保证异步的 provider 只执行一次
-     */
-    private promiseMap;
-    constructor(opts: {
-        /**
-         * 最大缓存大小，超出后将出触发清除缓存操作
-         */
-        maxSize: number;
-        /**
-         * 缓存时长，单位秒
-         */
-        maxAge: number;
-    });
-    /**
-     * 获取缓存
-     */
-    get(key: string): CacheVal | null;
-    /**
-     * 设置缓存内容，如果缓存内容超过最大缓存大小，则触发清除缓存操作
-     * @param key
-     * @param value
-     * @returns
-     */
-    set(key: string, value: CacheVal): void;
-    /**
-     * 删除缓存
-     */
-    remove(key: string): void;
-    /**
-     * 如果缓存不存在，则计算缓存内容并放入缓存
-     * @param key
-     * @param provider 计算函数，返回值将放入缓存，如果返回 null 则表示未能计算出缓存内容，不进行缓存
-     */
-    computeIfAbsent(key: string, provider: () => Promise<CacheVal | null>): Promise<CacheVal | null>;
-    /**
-     * 清理无用的缓存内容
-     */
-    private clean;
-    /**
-     * 清除缓存内容
-     */
-    clear(): void;
-}
+/// <reference types="node" />
+export interface CacheVal {
+    /**
+     * 文件内容
+     */
+    buffer: Buffer;
+    /**
+     * 媒体类型
+     */
+    mimeType: string;
+    /**
+     * 修改时间
+     */
+    mtime: Date;
+    /**
+     * 客户端缓存时间
+     */
+    cacheAge?: number;
+}
+/**
+ * 文件的服务器缓存
+ */
+export declare class ServerCache {
+    private readonly opts;
+    /**
+     * 当前的缓存内容大小，单位字节
+     */
+    private size;
+    /**
+     * 缓存内容
+     */
+    private readonly cacheMap;
+    /**
+     * promise 表，作用是处理异步并发问题，如果有相同的 key 同时请求，保证异步的 provider 只执行一次
+     */
+    private promiseMap;
+    constructor(opts: {
+        /**
+         * 最大缓存大小，超出后将出触发清除缓存操作
+         */
+        maxSize: number;
+        /**
+         * 缓存时长，单位秒
+         */
+        maxAge: number;
+    });
+    /**
+     * 获取缓存
+     */
+    get(key: string): CacheVal | null;
+    /**
+     * 设置缓存内容，如果缓存内容超过最大缓存大小，则触发清除缓存操作
+     * @param key
+     * @param value
+     * @returns
+     */
+    set(key: string, value: CacheVal): void;
+    /**
+     * 删除缓存
+     */
+    remove(key: string): void;
+    /**
+     * 如果缓存不存在，则计算缓存内容并放入缓存
+     * @param key
+     * @param provider 计算函数，返回值将放入缓存，如果返回 null 则表示未能计算出缓存内容，不进行缓存
+     */
+    computeIfAbsent(key: string, provider: () => Promise<CacheVal | null>): Promise<CacheVal | null>;
+    /**
+     * 清理无用的缓存内容
+     */
+    private clean;
+    /**
+     * 清除缓存内容
+     */
+    clear(): void;
+}