UNPKG

7.09 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="UTF-8">
5<meta http-equiv="Content-Type" name="viewport" content="width=device-width, initial-scale=1"/>
6<title>API</title>
7<link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/normalize-4.2.0.min.css">
8
9 <link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/github-markdown-2.3.0.min.css">
10 <link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.css">
11</head>
12<body>
13<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1"
14 style="width:0;height:0;position:absolute;overflow:hidden;">
15 <defs>
16 <symbol id="si-zfinder-collapse-left" viewBox="0 0 38 38">
17 <path d="M38 0H0v38h38V0zM3 35V3h32v32H3zM5 5v28h17V21h-9.667L16 26h-4l-5-7 5-7h4l-3.667 5H22V5H5z"/>
18 </symbol>
19 <symbol id="si-zfinder-expand-right" viewBox="0 0 38 38">
20 <path d="M0 0h38v38H0V0zm35 35V3H3v32h32zM22 5v28H5V21h9.667L11 26h4l5-7-5-7h-4l3.667 5H5V5h17z"/>
21 </symbol>
22 <symbol id="si-zfinder-fullscreen" viewBox="0 0 28 28">
23 <path d="M4 18H0v10h10v-4H4v-6zm-4-8h4V4h6V0H0v10zm24 14h-6v4h10V18h-4v6zM18 0v4h6v6h4V0H18z"/>
24 </symbol>
25 <symbol id="si-zfinder-fullscreen-exit" viewBox="0 0 28 28">
26 <path d="M0 22h6v6h4V18H0v4zM6 6H0v4h10V0H6v6zm12 22h4v-6h6v-4H18v10zm4-22V0h-4v10h10V6h-6z"/>
27 </symbol>
28 </defs>
29</svg>
30<nav id="toc">
31 <div id="toc-body" class="toc-body"></div>
32</nav>
33<article id="markdown">
34 <nav id="markdown-header" class="markdown-header">
35 <svg class="si" id="toggle-toc" width="24" height="24">
36 <use xlink:href="#si-zfinder-collapse-left"></use>
37 </svg>
38 <svg class="si float-right" id="toggle-fullscreen-article" width="24" height="24">
39 <use xlink:href="#si-zfinder-fullscreen"></use>
40 </svg>
41 </nav>
42 <div id="markdown-body" class="markdown-body"><h1>API</h1>
43<h2>Properties</h2>
44<table>
45<thead>
46<tr>
47<th>supported</th>
48<th>name</th>
49<th>description</th>
50</tr>
51</thead>
52<tbody>
53<tr>
54<td>yes</td>
55<td>domParser</td>
56<td>instance of DOMParser</td>
57</tr>
58<tr>
59<td>yes</td>
60<td>xmlSerializer</td>
61<td>instance of XMLSerializer</td>
62</tr>
63</tbody>
64</table>
65<h2>Methods</h2>
66<h3>Parsing/Serializing</h3>
67<table>
68<thead>
69<tr>
70<th>supported</th>
71<th>name</th>
72<th>alias</th>
73<th>parameters</th>
74<th>return value</th>
75<th>description</th>
76</tr>
77</thead>
78<tbody>
79<tr>
80<td>yes</td>
81<td>parse</td>
82<td>parseFromString</td>
83<td>String str</td>
84<td>Document doc</td>
85<td>parsing a xml string</td>
86</tr>
87<tr>
88<td>yes</td>
89<td>serialize</td>
90<td>serializeToString</td>
91<td>Document doc</td>
92<td>String str</td>
93<td>Document to xml string</td>
94</tr>
95</tbody>
96</table>
97<h3>DOM maintaining</h3>
98<table>
99<thead>
100<tr>
101<th>supported</th>
102<th>name</th>
103<th>alias</th>
104<th>parameters</th>
105<th>return value</th>
106<th>description</th>
107</tr>
108</thead>
109<tbody>
110<tr>
111<td>yes</td>
112<td>attributesAsObject</td>
113<td></td>
114<td>Node doc</td>
115<td>Node child</td>
116<td>attributes to key-value pairs</td>
117</tr>
118<tr>
119<td>yes</td>
120<td>findChildNode</td>
121<td></td>
122<td>Node doc, Object query</td>
123<td>Node child</td>
124<td>find one child node</td>
125</tr>
126<tr>
127<td>yes</td>
128<td>findChildNodes</td>
129<td></td>
130<td>Node doc, Object query</td>
131<td>Array(Node)</td>
132<td>find child nodes</td>
133</tr>
134<tr>
135<td>yes</td>
136<td>findNodes</td>
137<td></td>
138<td>Node doc, Object query</td>
139<td>Array(Node)</td>
140<td>find nodes</td>
141</tr>
142<tr>
143<td>yes</td>
144<td>findOrCreateChildNode</td>
145<td></td>
146<td>Node doc, Object query</td>
147<td>Node child</td>
148<td>find or create one child node</td>
149</tr>
150<tr>
151<td>yes</td>
152<td>removeChildNode</td>
153<td></td>
154<td>Node doc, Object query</td>
155<td>Node child</td>
156<td>remove one child node</td>
157</tr>
158<tr>
159<td>yes</td>
160<td>eachChildNode</td>
161<td></td>
162<td>Node doc, Object query, Function callback</td>
163<td>null</td>
164<td>execute callback using child node as parameter</td>
165</tr>
166<tr>
167<td>yes</td>
168<td>eachNode</td>
169<td></td>
170<td>Node doc, Object query, Function callback</td>
171<td>null</td>
172<td>execute callback using node as parameter</td>
173</tr>
174</tbody>
175</table>
176<h4>Sample for <code>Object query</code></h4>
177<pre><code class="language-javascript"><span class="hljs-comment">// query for &lt;some-tag key="value"/&gt;</span>
178{
179 <span class="hljs-attr">tagName</span>: <span class="hljs-string">'some-tag'</span>, <span class="hljs-comment">// Node.tagName === 'some-tag'</span>
180 nodeName: <span class="hljs-string">'some-tag'</span>, <span class="hljs-comment">// Node.nodeName === 'some-tag'</span>
181 attributes: { <span class="hljs-comment">// Node.getAttribute('key') === 'value'</span>
182 key: <span class="hljs-string">'value'</span>
183 }
184}
185</code></pre>
186<h3>Formatting</h3>
187<table>
188<thead>
189<tr>
190<th>supported</th>
191<th>name</th>
192<th>alias</th>
193<th>parameters</th>
194<th>return value</th>
195<th>description</th>
196</tr>
197</thead>
198<tbody>
199<tr>
200<td>yes</td>
201<td>beautify</td>
202<td></td>
203<td>String xml, (String or Number) step</td>
204<td>String str</td>
205<td>beautify xml string</td>
206</tr>
207<tr>
208<td>yes</td>
209<td>uglify</td>
210<td></td>
211<td>String xml, Boolean preserveComments</td>
212<td>String str</td>
213<td>uglify xml string</td>
214</tr>
215<tr>
216<td>yes</td>
217<td>sanitize</td>
218<td></td>
219<td>String xml, Boolean reverse</td>
220<td>String str</td>
221<td>escape or unescape “&amp;”, “&lt;” and “&gt;”</td>
222</tr>
223</tbody>
224</table>
225<h3>Converting</h3>
226<table>
227<thead>
228<tr>
229<th>supported</th>
230<th>name</th>
231<th>alias</th>
232<th>parameters</th>
233<th>return value</th>
234<th>description</th>
235</tr>
236</thead>
237<tbody>
238<tr>
239<td>yes</td>
240<td>dom2js</td>
241<td></td>
242<td>Node node</td>
243<td>Object obj</td>
244<td>converting a Node instance into js object</td>
245</tr>
246<tr>
247<td>yes</td>
248<td>xml2js</td>
249<td></td>
250<td>String xml</td>
251<td>Object obj</td>
252<td>converting an xml string into js object</td>
253</tr>
254<tr>
255<td>yes</td>
256<td>xml2json</td>
257<td></td>
258<td>String xml, String replacer, String space</td>
259<td>String json</td>
260<td>converting an xml string into json string</td>
261</tr>
262<tr>
263<td>yes</td>
264<td>js2xml</td>
265<td></td>
266<td>Object obj, Object options</td>
267<td>String xml</td>
268<td>converting an object into xml string</td>
269</tr>
270<tr>
271<td>yes</td>
272<td>json2xml</td>
273<td></td>
274<td>String json, Object options</td>
275<td>String xml</td>
276<td>converting a json string into xml string</td>
277</tr>
278<tr>
279<td>yes</td>
280<td>js2dom</td>
281<td></td>
282<td>Object obj</td>
283<td>Node doc</td>
284<td>converting an object into a Node instance</td>
285</tr>
286<tr>
287<td>yes</td>
288<td>json2dom</td>
289<td></td>
290<td>String json</td>
291<td>Node doc</td>
292<td>converting a json string into a Node instance</td>
293</tr>
294</tbody>
295</table>
296</div>
297</article>
298<div id="loading">
299 <div class="sk-double-bounce">
300 <div class="sk-child sk-double-bounce1"></div>
301 <div class="sk-child sk-double-bounce2"></div>
302 </div>
303</div>
304
305<script src="https://leungwensen.github.io/zfinder/dist/lib/jquery-3.1.0.min.js"></script>
306<script src="https://leungwensen.github.io/zfinder/dist/lib/screenfull-3.0.0.min.js"></script>
307<script src="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.js"></script>
308</body>
309</html>