你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Serializer interface
用于将原始响应对象映射到最终形状。 帮助打包和解压缩日期和其他不是 JSON 固有的编码类型。 还允许从标头中拉取值,以及插入默认值和常量。
属性
isXML | 内容是否为 XML。 |
model |
提供的模型映射器。 |
方法
deserialize(Mapper, any, string, Serializer |
根据映射器中定义的元数据反序列化给定对象。 |
serialize(Mapper, any, string, Serializer |
根据映射器中定义的元数据序列化给定对象。 |
validate |
验证约束(如果有)。 如果提供的值不遵循这些约束,则此函数将引发。 |
属性详细信息
isXML
内容是否为 XML。
isXML: boolean
属性值
boolean
modelMappers
提供的模型映射器。
modelMappers: {[key: string]: any}
属性值
{[key: string]: any}
方法详细信息
deserialize(Mapper, any, string, SerializerOptions)
根据映射器中定义的元数据反序列化给定对象。
function deserialize(mapper: Mapper, responseBody: any, objectName: string, options?: SerializerOptions): any
参数
- mapper
- Mapper
定义可序列化对象的元数据的映射器。
- responseBody
-
any
要反序列化的有效 Javascript 实体。
- objectName
-
string
反序列化对象的名称。
- options
- SerializerOptions
控制 XML 分析器和生成器的行为。
返回
any
有效的反序列化 Javascript 对象。
serialize(Mapper, any, string, SerializerOptions)
根据映射器中定义的元数据序列化给定对象。
function serialize(mapper: Mapper, object: any, objectName?: string, options?: SerializerOptions): any
参数
- mapper
- Mapper
定义可序列化对象的元数据的映射器。
- object
-
any
要序列化的有效 Javascript 对象。
- objectName
-
string
序列化对象的名称。
- options
- SerializerOptions
反序列化的其他选项。
返回
any
有效的序列化 Javascript 对象。
validateConstraints(Mapper, any, string)
警告
现已弃用此 API。
Removing the constraints validation on client side.
验证约束(如果有)。 如果提供的值不遵循这些约束,则此函数将引发。
function validateConstraints(mapper: Mapper, value: any, objectName: string)
参数
- mapper
- Mapper
数据模型的定义。
- value
-
any
值。
- objectName
-
string
对象的名称。 在错误消息中使用。