mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
2a888886b1
* typings for xml2json
* carried out suggestions made by andy-ms
* fixed: 9:1 unified-signatures These overloads can be combined into one signature taking `{} | string`.
71 lines
2.1 KiB
TypeScript
71 lines
2.1 KiB
TypeScript
// Type definitions for xml2json 0.10
|
|
// Project: https://github.com/buglabs/node-xml2json
|
|
// Definitions by: Dolan Miu <https://github.com/dolanmiu>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
export function toJson(xml: string, options?: { object?: false } & JsonOptions): string;
|
|
export function toJson(xml: string, options?: { object: true } & JsonOptions): {};
|
|
|
|
export function toXml(json: {} | string, options?: XmlOptions): string;
|
|
|
|
export interface XmlOptions {
|
|
/**
|
|
* Sanitizes the following characters present in element values (default false):
|
|
* @example
|
|
* var chars = {
|
|
* '<': '<',
|
|
* '>': '>',
|
|
* '(': '(',
|
|
* ')': ')',
|
|
* '#': '#',
|
|
* '&': '&',
|
|
* '"': '"',
|
|
* "'": '''
|
|
* };
|
|
* @example
|
|
*/
|
|
sanitize?: boolean;
|
|
}
|
|
|
|
export interface JsonOptions {
|
|
/**
|
|
* Returns a Javascript object instead of a JSON string.
|
|
*/
|
|
// object?: boolean; // This is now overloaded in the toJson method
|
|
/**
|
|
* Makes the JSON reversible to XML.
|
|
* xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure.
|
|
*/
|
|
reversible?: boolean;
|
|
/**
|
|
* Makes type coercion.
|
|
* i.e.: numbers and booleans present in attributes and element values are converted from string to its correspondent data types.
|
|
* Coerce can be optionally defined as an object with specific methods of coercion based on attribute name or tag name, with fallback to default coercion.
|
|
*/
|
|
coerce?: boolean;
|
|
/**
|
|
* Sanitizes the following characters present in element values (default true):
|
|
* @example
|
|
* var chars = {
|
|
* '<': '<',
|
|
* '>': '>',
|
|
* '(': '(',
|
|
* ')': ')',
|
|
* '#': '#',
|
|
* '&': '&',
|
|
* '"': '"',
|
|
* "'": '''
|
|
* };
|
|
* @example
|
|
*/
|
|
sanitize?: boolean;
|
|
/**
|
|
* Removes leading and trailing whitespaces as well as line terminators in element values.
|
|
* Defaults to true.
|
|
*/
|
|
trim?: boolean;
|
|
/**
|
|
* XML child nodes are always treated as arrays
|
|
*/
|
|
arrayNotation?: boolean;
|
|
}
|