node-web-mvc/dist/servlets/http/converts/HttpMessageConverter.d.ts

node spring mvc

/**
 * @module HttpMessageConverter
 * @description 请求消息转换工具
 */
import ServletContext from '../ServletContext';
import MediaType from '../MediaType';
import { JsDataType } from '../../../interface/declare';
export default interface HttpMessageConverter<T = any> {
    /**
     * 获取当前支持支持的mediaType列表
     */
    getSupportedMediaTypes(): MediaType[];
    /**
     * 判断当前转换器是否能处理当前内容类型
     * @param mediaType 当前内容类型 例如: application/json
     */
    canRead(dataType: JsDataType, mediaType: MediaType): boolean;
    /**
     * 判断当前内容是否能写
     * @param mediaType 当前内容类型 例如: application/json
     */
    canWrite(dataType: JsDataType, mediaType: MediaType): boolean;
    /**
     * 读取当前消息内容
     * @param servletRequest
     */
    read(servletContext: ServletContext, dataType: Function): Promise<T>;
    /**
     * 写出当前内容
     * @param data 当前数据
     * @param mediaType 当前内容类型
     * @param servletContext 当前请求上下文
     */
    write(data: any, servletContext: ServletContext): Promise<any>;
}