xml转换JavaScript

About 2 min

xml转换JavaScript

icon-note.gif 说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import convertXml from '@ohos.convertxml'
1

权限

ConvertXML

convert

convert(xml: string, options?: ConvertOptions) : Object

转化xml文本为JavaScript对象。

  • 参数:

    参数名 类型 必填 说明
    xml string 传入的xml文本。
    options ConvertOptions 用户可进行的选项。
  • 返回值:

    类型 说明
    string 处理后返回的JavaScript对象。
  • 示例:

    import convertXml from '@ohos.convertxml'
    var xml =
        '<?xml version="1.0" encoding="utf-8"?>' +
        '<note importance="high" logged="true">' +
        '    <title>Happy</title>' +
        '    <todo>Work</todo>' +
        '    <todo>Play</todo>' +
        '</note>';
    var convertxml = new convertXml.ConvertXML();
    var result1 = convertxml.convert(xml, {compact: false, spaces: 0});
    console.log(result1)
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

ConvertOptions

名称 参数类型 必填 说明
trim boolean 是否修剪位于文本前后的空白字符,默认false。
ignoreDeclaration boolean 是否忽略xml写入声明指示,默认false。
ignoreInstruction boolean 是否忽略xml的写入处理指令,默认false。
ignoreAttributes boolean 是否跨多行打印属性并缩进属性,默认false。
ignoreComment boolean 是否忽略元素的注释信息,默认false。
ignoreCdata boolean 是否忽略元素的CData信息,默认false。
ignoreDoctype boolean 是否忽略元素的Doctype信息,默认false。
ignoreText boolean 是否忽略元素的文本信息,默认false。
declarationKey string 用于输出对象中declaration的属性键的名称,默认_declaration。
instructionKey string 用于输出对象中instruction的属性键的名称,默认_instruction。
attributesKey string 用于输出对象中attributes的属性键的名称,默认_attributes。
textKey string 用于输出对象中text的属性键的名称,默认_text。
cdataKey string 用于输出对象中cdata的属性键的名称,默认_cdata。
doctypeKey string 用于输出对象中doctype的属性键的名称,默认_doctype。
commentKey string 用于输出对象中comment的属性键的名称,默认_comment。
parentKey string 用于输出对象中parent的属性键的名称,默认_parent。
typeKey string 用于输出对象中type的属性键的名称,默认_type。
nameKey string 用于输出对象中name的属性键的名称,默认_name。
elementsKey string 用于输出对象中elements的属性键的名称,默认_elements。