Interface IDeclarationOptions

The options associated with the XML declaration. An example of an XML declaration is as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

Hierarchy

  • IDeclarationOptions

Properties

encoding? include? standalone? version?

Properties

Optional encoding

encoding?: string

The encoding attribute to be included in the declaration. If defined, this value must be a valid encoding. By default, no encoding attribute is included.

Optional include

include?: boolean

Whether to include a declaration in the generated XML. By default, one is included.

Optional standalone

standalone?: string

The value of the standalone attribute to be included in the declaration. If defined, this value must be "yes" or "no". By default, no standalone attribute is included.

Optional version

version?: string

The XML version to be included in the declaration. If defined, this value must be a valid XML version number. Defaults to "1.0".

Settings

Member Visibility

Theme

Generated using TypeDoc