katoikia-app/web-ui/web-react/node_modules/xml-name-validator
Maria Sanchez 5abf040b42 fix web ui template 2022-07-05 22:15:11 -06:00
..
lib fix web ui template 2022-07-05 22:15:11 -06:00
LICENSE.txt fix web ui template 2022-07-05 22:15:11 -06:00
README.md fix web ui template 2022-07-05 22:15:11 -06:00
package.json fix web ui template 2022-07-05 22:15:11 -06:00

README.md

Validate XML Names and Qualified Names

This package simply tells you whether or not a string matches the Name or QName productions in the XML Namespaces specification. We use it for implementing the validate algorithm in jsdom, but you can use it for whatever you want.

Usage

This package's main module's default export takes a string and will return an object of the form { success, error }, where success is a boolean and if it is false, then error is a string containing some hint as to where the match went wrong.

"use strict":
var xnv = require("xml-name-validator");
var assert = require("assert");

// Will return { success: true, error: undefined }
xnv.name("x");
xnv.name(":");
xnv.name("a:0");
xnv.name("a:b:c");

// Will return { success: false, error: <an explanatory string> }
xnv.name("\\");
xnv.name("'");
xnv.name("0");
xnv.name("a!");

// Will return { success: true, error: undefined }
xnv.qname("x");
xnv.qname("a0");
xnv.qname("a:b");

// Will return { success: false, error: <an explanatory string> }
xnv.qname(":a");
xnv.qname(":b");
xnv.qname("a:b:c");
xnv.qname("a:0");