Logo for jsDocs.io

xmlchars

  • Version 2.2.0
  • Published
  • 59 kB
  • No dependencies
  • MIT license

Install

npm i xmlchars
yarn add xmlchars
pnpm add xmlchars

Overview

Utilities for determining if characters belong to character classes defined by the XML specs.

Index

Namespaces

Namespaces

namespace XML_1_0

namespace XML_1_0 {}

  • Character class utilities for XML 1.0.

namespace XML_1_0.ED4

namespace XML_1_0.ED4 {}

  • Fourth edition. These are deprecated in the 5th edition but some of the standards related to XML 1.0 (e.g. XML Schema 1.0) refer to these. So they are still generally useful.

namespace XML_1_0.ED4.fragments

namespace XML_1_0.ED4.fragments {}

  • Regular expression fragments. These fragments are designed to be included inside square brackets in a regular expression.

variable BASE_CHAR

const BASE_CHAR: string;

    variable CHAR

    const CHAR: string;

      variable COMBINING_CHAR

      const COMBINING_CHAR: string;

        variable DIGIT

        const DIGIT: string;

          variable EXTENDER

          const EXTENDER: string;

            variable IDEOGRAPHIC

            const IDEOGRAPHIC: string;

              variable LETTER

              const LETTER: string;

                variable NAME_CHAR

                const NAME_CHAR: string;

                  variable S

                  const S: string;

                    namespace XML_1_0.ED4.regexes

                    namespace XML_1_0.ED4.regexes {}

                    • Regular expression. These correspond to the productions of the same name in the specification.

                    variable BASE_CHAR

                    const BASE_CHAR: RegExp;

                      variable CHAR

                      const CHAR: RegExp;

                        variable COMBINING_CHAR

                        const COMBINING_CHAR: RegExp;

                          variable DIGIT

                          const DIGIT: RegExp;

                            variable EXTENDER

                            const EXTENDER: RegExp;

                              variable IDEOGRAPHIC

                              const IDEOGRAPHIC: RegExp;

                                variable LETTER

                                const LETTER: RegExp;

                                  variable NAME

                                  const NAME: RegExp;

                                    variable NAME_CHAR

                                    const NAME_CHAR: RegExp;

                                      variable NMTOKEN

                                      const NMTOKEN: RegExp;

                                        variable S

                                        const S: RegExp;

                                          namespace XML_1_0.ED5

                                          namespace XML_1_0.ED5 {}

                                          • Fifth edition.

                                          variable isChar

                                          const isChar: (c: number) => boolean;

                                          • Determines whether a codepoint matches the ``CHAR`` production.

                                            Parameter c

                                            The code point.

                                            Returns

                                            ``true`` if the codepoint matches ``CHAR``.

                                          variable isNameChar

                                          const isNameChar: (c: number) => boolean;

                                          • Determines whether a codepoint matches the ``NAME_CHAR`` production.

                                            Parameter c

                                            The code point.

                                            Returns

                                            ``true`` if the codepoint matches ``NAME_CHAR``.

                                          variable isNameStartChar

                                          const isNameStartChar: (c: number) => boolean;

                                          • Determines whether a codepoint matches the ``NAME_START_CHAR`` production.

                                            Parameter c

                                            The code point.

                                            Returns

                                            ``true`` if the codepoint matches ``NAME_START_CHAR``.

                                          variable isS

                                          const isS: (c: number) => boolean;

                                          • Determines whether a codepoint matches the ``S`` (space) production.

                                            Parameter c

                                            The code point.

                                            Returns

                                            ``true`` if the codepoint matches ``S``.

                                          namespace XML_1_0.ED5.fragments

                                          namespace XML_1_0.ED5.fragments {}

                                          • Regular expression fragments. These fragments are designed to be included inside square brackets in a regular expression.

                                          variable CHAR

                                          const CHAR: string;

                                            variable NAME_CHAR

                                            const NAME_CHAR: string;

                                              variable NAME_START_CHAR

                                              const NAME_START_CHAR: string;

                                                variable S

                                                const S: string;

                                                  namespace XML_1_0.ED5.lists

                                                  namespace XML_1_0.ED5.lists {}

                                                  • Lists of characters.

                                                    The names defined in this namespace are arrays of codepoints which contain the set of codepoints that an XML production encompasses. Note that many productions are too large to be reasonably represented as sets.

                                                  variable S

                                                  const S: number[];

                                                    namespace XML_1_0.ED5.regexes

                                                    namespace XML_1_0.ED5.regexes {}

                                                    • Regular expression. These correspond to the productions of the same name in the specification.

                                                    variable CHAR

                                                    const CHAR: RegExp;

                                                      variable NAME

                                                      const NAME: RegExp;

                                                        variable NAME_CHAR

                                                        const NAME_CHAR: RegExp;

                                                          variable NAME_START_CHAR

                                                          const NAME_START_CHAR: RegExp;

                                                            variable NMTOKEN

                                                            const NMTOKEN: RegExp;

                                                              variable S

                                                              const S: RegExp;

                                                                namespace XMLNS_1_0

                                                                namespace XMLNS_1_0 {}

                                                                • Character class utilities for XML NS 1.0.

                                                                namespace XMLNS_1_0.ED3

                                                                namespace XMLNS_1_0.ED3 {}

                                                                • Third edition.

                                                                variable isNCNameChar

                                                                const isNCNameChar: (c: number) => boolean;

                                                                • Determines whether a codepoint matches [[regexes.NC_NAME_CHAR]].

                                                                  Parameter c

                                                                  The code point.

                                                                  Returns

                                                                  ``true`` if the codepoint matches.

                                                                variable isNCNameStartChar

                                                                const isNCNameStartChar: (c: number) => boolean;

                                                                • Determines whether a codepoint matches [[regexes.NC_NAME_START_CHAR]].

                                                                  Parameter c

                                                                  The code point.

                                                                  Returns

                                                                  ``true`` if the codepoint matches.

                                                                namespace XMLNS_1_0.ED3.fragments

                                                                namespace XMLNS_1_0.ED3.fragments {}

                                                                • Regular expression fragments. These fragments are designed to be included inside square brackets in a regular expression.

                                                                variable NC_NAME_CHAR

                                                                const NC_NAME_CHAR: string;

                                                                  variable NC_NAME_START_CHAR

                                                                  const NC_NAME_START_CHAR: string;

                                                                    namespace XMLNS_1_0.ED3.regexes

                                                                    namespace XMLNS_1_0.ED3.regexes {}

                                                                    • Regular expression. These correspond to the productions of the same name in the specification.

                                                                    variable NC_NAME

                                                                    const NC_NAME: RegExp;

                                                                      variable NC_NAME_CHAR

                                                                      const NC_NAME_CHAR: RegExp;

                                                                        variable NC_NAME_START_CHAR

                                                                        const NC_NAME_START_CHAR: RegExp;

                                                                          Package Files (1)

                                                                          Dependencies (0)

                                                                          No dependencies.

                                                                          Dev Dependencies (12)

                                                                          Peer Dependencies (0)

                                                                          No peer dependencies.

                                                                          Badge

                                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/xmlchars.

                                                                          • Markdown
                                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/xmlchars)
                                                                          • HTML
                                                                            <a href="https://www.jsdocs.io/package/xmlchars"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>