Merge pull request #4573 from wallymathieu/master

Type definitions for xmlbuilder
2026-08-30 11:14:27 +08:00 · 2015-06-14 14:09:42 +09:00
parent 87683b5c77 fc8ac28f9c
commit 0ce0a63a4f
2 changed files with 133 additions and 0 deletions
@@ -0,0 +1,44 @@
+/// <reference path="xmlbuilder.d.ts" />
+
+import xmlbuilder = require('xmlbuilder');
+var xml = xmlbuilder.create;
+
+// https://github.com/oozcitak/xmlbuilder-js/blob/master/test/comment.coffee
+xml('comment', {}, {}, { headless: true }).comment('<>\'"&\t\n\r').end();
+
+// https://github.com/oozcitak/xmlbuilder-js/blob/master/test/instructions.coffee
+xml('test17', { headless: true }).ins('pi', 'mypi').end();
+
+xml('test17', { headless: true }).ins({ 'pi': 'mypi', 'pi2': 'mypi2', 'pi3': null }).end();
+
+xml('test17', { headless: true }).ins(['pi', 'pi2']).end();
+
+xml('test18', { headless: true })
+    .ins('renderCache.subset', '"Verdana" 0 0 ISO-8859-1 4 268 67 "#(),-./')
+    .ins('pitarget', () => 'pivalue')
+    .end();
+
+// https://github.com/oozcitak/xmlbuilder-js/blob/master/test/createxml.coffee
+xml('root')
+    .ele('xmlbuilder')
+    .att('for', 'node-js')
+    .com('CoffeeScript is awesome.')
+    .nod('repo')
+    .att('type', 'git')
+    .txt('git://github.com/oozcitak/xmlbuilder-js.git')
+    .up()
+    .up()
+    .ele('test')
+    .att('escaped', 'chars <>\'"&\t\n\r')
+    .txt('complete 100%<>\'"&\t\n\r')
+    .up()
+    .ele('cdata')
+    .cdata('<test att="val">this is a test</test>\nSecond line')
+    .up()
+    .ele('raw')
+    .raw('&<>&')
+    .up()
+    .ele('atttest', { 'att': 'val' }, 'text')
+    .up()
+    .ele('atttest', 'text')
+    .end();
@@ -0,0 +1,89 @@
+// Type definitions for xmlbuilder
+// Project: https://github.com/oozcitak/xmlbuilder-js
+// Definitions by: Wallymathieu <http://github.com/wallymathieu>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module 'xmlbuilder' {
+    export = xmlbuilder;
+    class XMLDocType {
+        clone(): XMLDocType;
+        element(name: string, value?: Object): XMLDocType;
+        attList(elementName: string, attributeName: string, attributeType: string, defaultValueType?: string, defaultValue?: any): XMLDocType;
+        entity(name: string, value: any): XMLDocType;
+        pEntity(name: string, value: any): XMLDocType;
+        notation(name: string, value: any): XMLDocType;
+        cdata(value: string): XMLDocType;
+        comment(value: string): XMLDocType;
+        instruction(target: string, value: any): XMLDocType;
+        root(): XMLDocType;
+        document(): any;
+        toString(options?: Object, level?: Number): string;
+
+        ele(name: string, value?: Object): XMLDocType;
+        att(elementName: string, attributeName: string, attributeType: string, defaultValueType?: string, defaultValue?: any): XMLDocType;
+        ent(name: string, value: any): XMLDocType;
+        pent(name: string, value: any): XMLDocType;
+        not(name: string, value: any): XMLDocType;
+        dat(value: string): XMLDocType;
+        com(value: string): XMLDocType;
+        ins(target: string, value: any): XMLDocType;
+        up(): XMLDocType;
+        doc(): any;
+    }
+
+    class XMLElementOrXMLNode {
+        // XMLElement:
+        clone(): XMLElementOrXMLNode;
+        attribute(name: any, value?: any): XMLElementOrXMLNode;
+        att(name: any, value?: any): XMLElementOrXMLNode;
+        removeAttribute(name: string): XMLElementOrXMLNode;
+        instruction(target: string, value: any): XMLElementOrXMLNode;
+        instruction(array: Array<any>): XMLElementOrXMLNode;
+        instruction(obj: Object): XMLElementOrXMLNode;
+        ins(target: string, value: any): XMLElementOrXMLNode;
+        ins(array: Array<any>): XMLElementOrXMLNode;
+        ins(obj: Object): XMLElementOrXMLNode;
+        a(name: any, value?: any): XMLElementOrXMLNode;
+        i(target: string, value: any): XMLElementOrXMLNode;
+        i(array: Array<any>): XMLElementOrXMLNode;
+        i(obj: Object): XMLElementOrXMLNode;
+        toString(options?:Object, level?:Number): string;
+        // XMLNode:
+        element(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        ele(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        insertBefore(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        insertAfter(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        remove(): XMLElementOrXMLNode;
+        node(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        text(value: string): XMLElementOrXMLNode;
+        cdata(value: string): XMLElementOrXMLNode;
+        comment(value: string): XMLElementOrXMLNode;
+        raw(value: string): XMLElementOrXMLNode;
+        declaration(version: string, encoding: string, standalone: boolean): XMLElementOrXMLNode;
+        doctype(pubID: string, sysID: string): XMLDocType;
+        up(): XMLElementOrXMLNode;
+        root(): XMLElementOrXMLNode;
+        document(): any;
+        end(options?: Object): string;
+        prev(): XMLElementOrXMLNode;
+        next(): XMLElementOrXMLNode;
+        nod(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        txt(value: string): XMLElementOrXMLNode;
+        dat(value: string): XMLElementOrXMLNode;
+        com(value: string): XMLElementOrXMLNode;
+        doc(): XMLElementOrXMLNode;
+        dec(version: string, encoding: string, standalone: boolean): XMLElementOrXMLNode;
+        dtd(pubID: string, sysID: string): XMLDocType;
+        e(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        n(name: any, attributes?: Object, text?: any): XMLElementOrXMLNode;
+        t(value: string): XMLElementOrXMLNode;
+        d(value: string): XMLElementOrXMLNode;
+        c(value: string): XMLElementOrXMLNode;
+        r(value: string): XMLElementOrXMLNode;
+        u(): XMLElementOrXMLNode;
+    }
+
+    module xmlbuilder {
+        function create(name: string, xmldec?: Object, doctype?: any, options?: Object): XMLElementOrXMLNode;
+    }
+}