node-jsontoxml - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #go #android #rust #deep-learning #linux #nodejs #kubernetes #vue #pytorch #ios #open-source

node-jsontoxml

(★ 98)

this renders a simple javascript object structure into xml/html. js objects are easier to modify than strings so no need to parse a whole dom to reliably add a few elements. while this could support async callbacks it doesn't. if people need it i will be happy to add support.

파일 탐색기

최종 버전 다운로드 (.zip)

.gitignore
.travis.yml
jsontoxml.js
LICENSE
package.json
README.md
test.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/soldair/node-jsontoxml

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd node-jsontoxml

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://secure.travis-ci.org/soldair/node-jsontoxml.png)](http://travis-ci.org/soldair/node-jsontoxml)

[![browser support](http://ci.testling.com/soldair/node-jsontoxml.png)](http://ci.testling.com/soldair/node-jsontoxml)

# jsontoxml

This is a library designed to render js objects as xml. Its not made to parse or otherwise edit existing xml/html structures.
For that and perhaps as a compliment to this you can use jsdom or xml2js for editing existing markup.

this will do a good job rendering json as xml but apis that require xml expect odd things mostly related to elements with attributes and implicit array like keys that make formatting your json a little tricky.

## example

```js
var jsonxml = require('jsontoxml');

var xml = jsonxml({
	node:'text content',
	parent:[
		{name:'taco',text:'beef taco',children:{salsa:'hot!'}},
		{name:'taco',text:'fish taco',attrs:{mood:'sad'},children:[
			{name:'salsa',text:'mild'},
			'hi',
			{name:'salsa',text:'weak',attrs:{type:2}}
		]},
		{name:'taco',attrs:'mood="party!"'}
	],
	parent2:{
		hi:'is a nice thing to say',
		node:'i am another not special child node',
		date:function(){
			return (new Date())+'';
		}
	}
})

console.log(xml);

```

outputs:
```xml
<node>text content</node>
<parent>
	<taco>
		beef taco
		<salsa>hot!</salsa>
	</taco>
	<taco mood='sad'>
		fish taco
		<salsa>mild</salsa>
		hi
		<salsa type="2">weak</salsa>
	</taco>
	<taco mood='party!'/>
</parent>
<parent2>
	<hi>is a nice thing to say</hi>
	<node>i am another not special child node</node>
	<date>Sun Sep 26 2010 17:27:29 GMT-0700 (PDT)</date>
</parent2>
```
## API

`jsontoxml (obj,options)`

* a valid json structure to interpret or a json string
* returns an xml string
  * `options` is optional. it can be true (add generic xml header) or an object. If an object, valid options are:
    - `escape`
      * calls escape on all values
      * attribute values if attribute values are specified as an object
    - `xmlHeader` can either be boolan (add generic `<?xml …?>` header) or an object. If an object valid options are:
      - `standalone` if true, the `<?xml …?>` gets an additional attribute       `standalone="yes"`.
    - `docType` if defined gets added as the `<!DOCTYPE …>` contents (unescaped).
    - `prettyPrint` if truthy the output gets a rudimentary pretty print (good for debugging, don't expect too much)
    - `indent` specify what unit you would like to indent by (spaces, tabstop, nothing - pass an empty string)
    - `removeIllegalNameCharacters` replace illegal XML element Name characters with '_'
    - `html` instead of adding self closing tags for empty tags add an open and close tag. `<salsa/>` becomes `<salsa></salsa>`

`jsontoxml.escape (string)`

* returns string with xml entities escaped
* escapes `"" & < >`

`jsontoxml.cdata (string)`

* wraps string with `<![CDATA[ ]]>`
 * removes all occurences of close cdata (`]]>`) in input text

## more description

I made this because i wanted to abstract away the fact that antiquated external systems require post data as xml and i wanted to expose a standard js calling api like my other interfaces.

I did not want to instantiate an entire dom to perform simple updates to tags in lower level functions (like injecting api keys) when top level api call specific functions start building the xml string.