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