mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
d4e7c79bb1
* use Record # Conflicts: # types/xml2json/index.d.ts * fix * use generics * fix lint errors from using generics only once
85 lines
2.7 KiB
TypeScript
85 lines
2.7 KiB
TypeScript
// Type definitions for xml2json 0.11
|
|
// Project: https://github.com/buglabs/node-xml2json
|
|
// Definitions by: Dolan Miu <https://github.com/dolanmiu>
|
|
// Igor Strebezhev <https://github.com/xamgore>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
export function toJson(xml: string | Buffer, options?: { object?: false } & JsonOptions): string;
|
|
export function toJson(xml: string | Buffer, options?: { object: true } & JsonOptions): { [key: string]: unknown };
|
|
|
|
export function toXml(json: { [key: string]: unknown } | string | Buffer, options?: XmlOptions): string;
|
|
|
|
export interface XmlOptions {
|
|
/**
|
|
* Sanitizes the following characters present in element values (default false):
|
|
* @example
|
|
* var chars = {
|
|
* '<': '<',
|
|
* '>': '>',
|
|
* '(': '(',
|
|
* ')': ')',
|
|
* '#': '#',
|
|
* '&': '&',
|
|
* '"': '"',
|
|
* "'": '''
|
|
* };
|
|
* @example
|
|
*/
|
|
sanitize?: boolean;
|
|
/**
|
|
* Ignores all null values.
|
|
*/
|
|
ignoreNull?: 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.
|
|
* You can specify a selective array of nodes for this to apply to instead of the whole document.
|
|
*/
|
|
arrayNotation?: boolean | string[];
|
|
/**
|
|
* Changes the default textNode property from $t to _t when option is set to true.
|
|
* Alternatively a string can be specified which will override $t to what ever the string is.
|
|
*/
|
|
alternateTextNode?: boolean | string;
|
|
}
|