Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
36 lines
999 B
Markdown
36 lines
999 B
Markdown
# Validate XML Names and Qualified Names
|
|
|
|
This package simply tells you whether or not a string matches the [`Name`](http://www.w3.org/TR/xml/#NT-Name) or [`QName`](http://www.w3.org/TR/xml-names/#NT-QName) productions in the XML Namespaces specification. We use it for implementing the [validate](https://dom.spec.whatwg.org/#validate) algorithm in jsdom, but you can use it for whatever you want.
|
|
|
|
## Usage
|
|
|
|
This package's main module exports two functions, `name()` and `qname()`. Both take a string and return a boolean indicating whether or not the string matches the relevant production.
|
|
|
|
```js
|
|
"use strict":
|
|
const xnv = require("xml-name-validator");
|
|
|
|
// Will return true
|
|
xnv.name("x");
|
|
xnv.name(":");
|
|
xnv.name("a:0");
|
|
xnv.name("a:b:c");
|
|
|
|
// Will return false
|
|
xnv.name("\\");
|
|
xnv.name("'");
|
|
xnv.name("0");
|
|
xnv.name("a!");
|
|
|
|
// Will return true
|
|
xnv.qname("x");
|
|
xnv.qname("a0");
|
|
xnv.qname("a:b");
|
|
|
|
// Will return false
|
|
xnv.qname(":a");
|
|
xnv.qname(":b");
|
|
xnv.qname("a:b:c");
|
|
xnv.qname("a:0");
|
|
```
|