saxes

constructor

constructor(opt?: SaxesOptions);

• Parameter opt

  The parser options.

property closed

readonly closed: boolean;

• Indicates whether or not the parser is closed. If ``true``, wait for the ``ready`` event to write again.

property column

column: number;

• The column number of the next character to be read by the parser. * This field is zero-based. (The first column is 0.)

  This field counts columns by *Unicode character*. Note that this *can* be different from the index of the character in a JavaScript string due to how JavaScript handles astral plane characters.

  See [[columnIndex]] for a number that corresponds to the JavaScript index.

property columnIndex

readonly columnIndex: number;

• The column number of the next character to be read by the parser. * This field is zero-based. (The first column in a line is 0.)

  This field reports the index at which the next character would be in the line if the line were represented as a JavaScript string. Note that this *can* be different to a count based on the number of *Unicode characters* due to how JavaScript handles astral plane characters.

  See [[column]] for a number that corresponds to a count of Unicode characters.

property ENTITIES

ENTITIES: Record<string, string>;

• A map of entity name to expansion.

property line

line: number;

• The line number of the next character to be read by the parser. This field is one-based. (The first line is numbered 1.)

property opt

readonly opt: SaxesOptions;

property position

readonly position: number;

• The stream position the parser is currently looking at. This field is zero-based.

  This field is not based on counting Unicode characters but is to be interpreted as a plain index into a JavaScript string.

property xmlDecl

xmlDecl: XMLDecl;

• The XML declaration for this document.

method close

close: () => this;

• Close the current stream. Perform final well-formedness checks and reset the parser tstate.

  Returns

  this

method fail

fail: (message: string) => this;

• Report a parsing error. This method is made public so that client code may check for issues that are outside the scope of this project and can report errors.

  Parameter message

  The error to report.

  Returns

  this

method makeError

makeError: (message: string) => Error;

• Make an error object. The error object will have a message that contains the ``fileName`` option passed at the creation of the parser. If position tracking was turned on, it will also have line and column number information.

  Parameter message

  The message describing the error to report.

  Returns

  An error object with a properly formatted message.

method off

off: (name: EventName) => void;

• Unset an event handler.

  name The event to stop listening to.

method on

on: <
    N extends
        | 'xmldecl'
        | 'text'
        | 'processinginstruction'
        | 'doctype'
        | 'comment'
        | 'opentagstart'
        | 'attribute'
        | 'opentag'
        | 'closetag'
        | 'cdata'
        | 'error'
        | 'end'
        | 'ready'
>(
    name: N,
    handler: EventNameToHandler<O, N>
) => void;

• Set an event listener on an event. The parser supports one handler per event type. If you try to set an event handler over an existing handler, the old handler is silently overwritten.

  Parameter name

  The event to listen to.

  Parameter handler

  The handler to set.

method resolve

resolve: (prefix: string) => string | undefined;

• Resolve a namespace prefix.

  Parameter prefix

  The prefix to resolve.

  Returns

  The namespace URI or ``undefined`` if the prefix is not defined.

method write

write: (chunk: string | object | null) => this;

• Write a XML data to the parser.

  Parameter chunk

  The XML data to write.

  Returns

  this

property fileName

fileName?: string;

• A file name to use for error reporting. "File name" is a loose concept. You could use a URL to some resource, or any descriptive name you like.

property fragment

fragment?: boolean;

• Whether to accept XML fragments. Unset means ``false``.

property position

position?: boolean;

• Whether to track positions. Unset means ``true``.

property defaultXMLVersion

defaultXMLVersion: Exclude<XMLVersionOptions['defaultXMLVersion'], undefined>;

property forceXMLVersion

forceXMLVersion: true;

property forceXMLVersion

forceXMLVersion?: false;

property additionalNamespaces

additionalNamespaces?: Record<string, string>;

• A plain object whose key, value pairs define namespaces known before parsing the XML file. It is not legal to pass bindings for the namespaces ``"xml"`` or ``"xmlns"``.

property resolvePrefix

resolvePrefix?: ResolvePrefix;

• A function that will be used if the parser cannot resolve a namespace prefix on its own.

property xmlns

xmlns?: boolean;

• Whether to track namespaces. Unset means ``false``.

property xmlns

xmlns: true;

property additionalNamespaces

additionalNamespaces?: undefined;

property resolvePrefix

resolvePrefix?: undefined;

property xmlns

xmlns?: false;

property local

local: string;

• The attribute's local name. For instance ``a:b="c"`` would have ``"b"`` for ``local``.

property name

name: string;

• The attribute's name. This is the combination of prefix and local name. For instance ``a:b="c"`` would have ``a:b`` for name.

property prefix

prefix: string;

• The attribute's prefix. For instance ``a:b="c"`` would have ``"a"`` for ``prefix``.

property uri

uri: string;

• The namespace URI of this attribute.

property value

value: string;

• The attribute's value.

property name

name: string;

• The attribute's name.

property value

value: string;

• The attribute's value.

property attributes

attributes: Record<string, SaxesAttributeNS> | Record<string, string>;

• A map of attribute name to attributes. If namespaces are tracked, the values in the map are attribute objects. Otherwise, they are strings.

property isSelfClosing

isSelfClosing: boolean;

• Whether the tag is self-closing (e.g. ````).

property local

local?: string;

• The tag's local name. For instance ``<a:b>`` would have ``"b"`` for ``local``. Undefined if we do not track namespaces.

property name

name: string;

• The tag's name. This is the combination of prefix and global name. For instance ``<a:b>`` would have ``"a:b"`` for ``name``.

property ns

ns?: Record<string, string>;

• The namespace bindings in effect.

property prefix

prefix?: string;

• The tag's prefix. For instance ``<a:b>`` would have ``"a"`` for ``prefix``. Undefined if we do not track namespaces.

property uri

uri?: string;

• The namespace URI of this tag. Undefined if we do not track namespaces.

property encoding

encoding?: string;

• The encoding specified by the XML declaration.

property standalone

standalone?: string;

• The value of the standalone parameter

property version

version?: string;

• The version specified by the XML declaration.

property defaultXMLVersion

defaultXMLVersion?: '1.0' | '1.1';

• The default XML version to use. If unspecified, and there is no XML encoding declaration, the default version is "1.0".

property forceXMLVersion

forceXMLVersion?: boolean;

• A flag indicating whether to force the XML version used for parsing to the value of ``defaultXMLVersion``. When this flag is ``true``, ``defaultXMLVersion`` must be specified. If unspecified, the default value of this flag is ``false``.