Class default`Abstract`

Provides static helper methods for parsing compilations from and to XML.

Devdoc

Code is written to work with the xml2js module specifically

Index

Constructors

Methods

FirstBooleanOf FirstNumberOf FirstStringOf convertToXml handleAsXmlCompilation parseFromXmlCompilation parseFromXmlCues parseFromXmlMeter parseFromXmlTimeSignature parseFromXmlTracks

Constructors

constructor

new default(): default
Returns default

Methods

`Static` `Private` FirstBooleanOf

FirstBooleanOf(array): null | boolean
Returns the first item in the array as a boolean, if defined. Otherwise, null is returned as a default.
Parameters
- array: string[]
Returns null | boolean
- Defined in src/code/xml/XmlCompilationParser.ts:93

`Static` `Private` FirstNumberOf

FirstNumberOf(array): null | number
Returns the first item in the array as a number, if defined. Otherwise, null is returned as a default.
Parameters
- array: string[]
Returns null | number
- Defined in src/code/xml/XmlCompilationParser.ts:79

`Static` `Private` FirstStringOf

FirstStringOf(array): string
Returns the first item in the array, if defined. Otherwise, the empty string is returned as a default.
Parameters
- array: string[]
Returns string
- Defined in src/code/xml/XmlCompilationParser.ts:72

`Static` convertToXml

convertToXml(compilation): string
Converts a compilation instance into its XML representation
Parameters
- compilation: ICompilation
Returns string
- Defined in src/code/xml/XmlCompilationParser.ts:62

`Static` handleAsXmlCompilation

handleAsXmlCompilation(content): Promise<ICompilation>
Handles the given Blob as having XML content and parses it into the compilation meta data
Parameters
- content: Blob
Returns Promise<ICompilation>
- Defined in src/code/xml/XmlCompilationParser.ts:228

`Static` `Private` parseFromXmlCompilation

parseFromXmlCompilation(xmlCompilation): ICompilation
Parses an XML object into an ICompilation.
Parameters
- xmlCompilation: any
  An object representing the stored Compilation from an XML import.
Returns ICompilation
Devdoc
The XML type contains all properties as arrays, even the single item ones. This is a limitation of the used XML-To-JS converter
- Defined in src/code/xml/XmlCompilationParser.ts:43

`Static` `Private` parseFromXmlCues

parseFromXmlCues(xmlCues): ICue[]
Parameters
- xmlCues: any
Returns ICue[]
Devdoc
The XML type contains all properties as arrays, even the single item ones. This is a limitation of the used XML-To-JS converter
- Defined in src/code/xml/XmlCompilationParser.ts:153

`Static` `Private` parseFromXmlMeter

parseFromXmlMeter(xmlMeter): null | IMeter
Parses an XML representation of a meter into an object instance.
Parameters
- xmlMeter: any
Returns null | IMeter
- Defined in src/code/xml/XmlCompilationParser.ts:185

`Static` `Private` parseFromXmlTimeSignature

parseFromXmlTimeSignature(xmlTimeSignature): null | ITimeSignature
Parses an XML representation of a time signature into an object instance.
Parameters
- xmlTimeSignature: any
Returns null | ITimeSignature
- Defined in src/code/xml/XmlCompilationParser.ts:204

`Static` `Private` parseFromXmlTracks

parseFromXmlTracks(xmlTracks): ITrack[]
Parameters
- xmlTracks: any[]
Returns ITrack[]
Devdoc
The XML type contains all properties as arrays, even the single item ones. This is a limitation of the used XML-To-JS converter
- Defined in src/code/xml/XmlCompilationParser.ts:106