Create a MediaType instance.
Parameters:
| Name |
Type |
Attributes |
Description |
data |
object
|
string
|
<optional>
|
Initial media type values or name.
Properties
| Name |
Type |
Attributes |
Description |
name |
string
|
null
|
<optional>
|
Media type name. |
properties |
Array.<(MediaTypeProperty|object)>
|
<optional>
|
Media type
properties. |
|
- Source:
Members
property
Return the media type properties array for legacy callers.
- Source:
Methods
Append one media-type property.
Parameters:
| Name |
Type |
Description |
property |
MediaTypeProperty
|
object
|
Media-type property to append. |
- Source:
Returns:
The same media type instance.
-
Type
-
MediaType
clear(scopeopt) → {MediaType}
Clear the full media type or only the properties list.
Parameters:
| Name |
Type |
Attributes |
Description |
scope |
"properties"
|
<optional>
|
Optional scope to clear. |
- Source:
Throws:
-
When scope is not `properties`
-
-
Type
-
Error
Returns:
The same media type instance.
-
Type
-
MediaType
isEmpty() → {boolean}
Whether the media type has any serializable values.
- Source:
Returns:
`true` when the media type is empty.
-
Type
-
boolean
Normalize the media type in place.
- Source:
Returns:
The same media type instance.
-
Type
-
MediaType
Remove one media-type property.
Parameters:
| Name |
Type |
Description |
index |
number
|
Property index to remove. |
- Source:
Throws:
-
When index is invalid or does not identify a property
-
-
Type
-
Error
Returns:
The same media type instance.
-
Type
-
MediaType
replace(index, property) → {MediaType}
Replace one media-type property.
Parameters:
| Name |
Type |
Description |
index |
number
|
Property index to replace. |
property |
MediaTypeProperty
|
object
|
Replacement property. |
- Source:
Throws:
-
When index is invalid or does not identify a property
-
-
Type
-
Error
Returns:
The same media type instance.
-
Type
-
MediaType
toElement(doc) → {Element|null}
Serialize the media type to XML.
Parameters:
| Name |
Type |
Description |
doc |
XMLDocument
|
XML document used to create elements. |
- Source:
Returns:
Serialized XML element, or `null` when empty.
-
Type
-
Element
|
null
toJSON() → {object}
Return a JSON-serializable representation of the media type.
- Source:
Returns:
Plain media type data.
-
Type
-
object
validate(pathopt) → {Array.<object>}
Validate the media type state.
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
path |
string
|
<optional>
|
mediaType
|
Base path used in validation errors. Defaults to
`mediaType`. |
- Source:
Returns:
Validation errors for invalid fields.
-
Type
-
Array.<object>
fromElement(element) → {MediaType}
Create a MediaType from a `mediaType` XML element.
Parameters:
| Name |
Type |
Description |
element |
Element
|
XML element to parse. |
- Source:
Returns:
Parsed media type instance.
-
Type
-
MediaType
fromValue(value) → {MediaType}
Coerce unknown input into a MediaType instance.
Parameters:
| Name |
Type |
Description |
value |
MediaType
|
object
|
string
|
null
|
undefined
|
Media type-like
input. |
- Source:
Returns:
Normalized media type.
-
Type
-
MediaType
parse(element, parseWarningsopt, pathopt) → {MediaType}
Parse a `mediaType` XML element while salvaging valid properties.
Unknown child nodes and ordering issues are ignored silently.
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
element |
Element
|
null
|
|
|
XML element to parse. |
parseWarnings |
Array.<object>
|
<optional>
|
|
Lossy parse warnings. |
path |
string
|
<optional>
|
mediaType
|
Field path used in warnings and validation. |
- Source:
Returns:
Parsed media type or an empty media type when
invalid.
-
Type
-
MediaType