Module "utils/utils"

Index

Interfaces

Type aliases

AnyObject

Functions

Type aliases

AnyObject

AnyObject: {}

Type declaration

[key: number]: unknown

Functions

cloneObject

cloneObject(obj: AnyObject, except?: string[] | number[]): object

- Defined in src/utils/utils.ts:81
Deep clones the given obj, except specific 1st-level keys.

Parameters
- obj: AnyObject
  
  object to be cloned.
- Optional except: string[] | number[]
  
  keys in this array will be erased from the clone.
Returns object

cloneWithoutHierarchy

cloneWithoutHierarchy(node: XmlNode | XmlDeclaration): XmlNode | XmlDeclaration

- Defined in src/utils/utils.ts:96
Clone the given node, without parent and nodes.

Parameters
- node: XmlNode | XmlDeclaration
Returns XmlNode | XmlDeclaration

createEmptyNode

createEmptyNode(type: XmlNodeTypes, piUseAttribute?: boolean): XmlNode

- Defined in src/utils/utils.ts:188
Creates an empty XML node.

Parameters
- type: XmlNodeTypes
- Default value piUseAttribute: boolean = false
  
  true if processing instruction should use attributes.
Returns XmlNode

defaultDeclaration

defaultDeclaration(parent?: XmlRoot): XmlDeclaration

- Defined in src/utils/utils.ts:229
Parameters
- Optional parent: XmlRoot
Returns XmlDeclaration

dehydrate

dehydrate(node: XmlNode | XmlDeclaration): void

- Defined in src/utils/utils.ts:207
Parameters
- node: XmlNode | XmlDeclaration
Returns void

kvpArray

kvpArray(obj: AnyObject, key?: string, value?: string, options?: KVPOptions): AnyObject[]

- Defined in src/utils/utils.ts:40
Converts object to key-value pair array.

Parameters
- obj: AnyObject
- Default value key: string = "key"
- Default value value: string = "value"
- Optional options: KVPOptions
Returns AnyObject[]

kvpObject

kvpObject(array: AnyObject[], key?: string, value?: string, options?: KVPOptions): AnyObject

- Defined in src/utils/utils.ts:60
Converts key-value pair array to object.

Parameters
- array: AnyObject[]
- Default value key: string = "key"
- Default value value: string = "value"
- Optional options: KVPOptions
Returns AnyObject

objXml

objXml(obj: object, options?: Options.JS2XML): string

- Defined in src/utils/utils.ts:137
Converts object to XML string

Parameters
- obj: object
- Optional options: Options.JS2XML
Returns string

rectifyAttributeValue

rectifyAttributeValue(value: string): string

- Defined in src/utils/utils.ts:165
Parameters
- value: string
Returns string

rectifyNodeAttributes

rectifyNodeAttributes(node: XmlNode | XmlDeclaration): void

- Defined in src/utils/utils.ts:174
Removes any object that has no name.

Parameters
- node: XmlNode | XmlDeclaration
Returns void

removeHierarchyFromNode

removeHierarchyFromNode(node: XmlNode | XmlDeclaration): void

- Defined in src/utils/utils.ts:160
Makes sure there is no hierarchy data. This function mutates the given node.

Parameters
- node: XmlNode | XmlDeclaration
Returns void

xmlJs

xmlJs(xml: string, options?: Options.XML2JS): XmlRoot | XmlDeclaration | XmlNode

- Defined in src/utils/utils.ts:110
Converts XML string to object.

Parameters
- xml: string
- Optional options: Options.XML2JS
Returns XmlRoot | XmlDeclaration | XmlNode

Generated using TypeDoc