aboutsummaryrefslogtreecommitdiffstats
path: root/vanilla/node_modules/xml-name-validator/README.md
diff options
context:
space:
mode:
authorAdam Mathes <adam@adammathes.com>2026-02-13 21:34:48 -0800
committerAdam Mathes <adam@adammathes.com>2026-02-13 21:34:48 -0800
commit76cb9c2a39d477a64824a985ade40507e3bbade1 (patch)
tree41e997aa9c6f538d3a136af61dae9424db2005a9 /vanilla/node_modules/xml-name-validator/README.md
parent819a39a21ac992b1393244a4c283bbb125208c69 (diff)
downloadneko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.gz
neko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.bz2
neko-76cb9c2a39d477a64824a985ade40507e3bbade1.zip
feat(vanilla): add testing infrastructure and tests (NK-wjnczv)
Diffstat (limited to 'vanilla/node_modules/xml-name-validator/README.md')
-rw-r--r--vanilla/node_modules/xml-name-validator/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/vanilla/node_modules/xml-name-validator/README.md b/vanilla/node_modules/xml-name-validator/README.md
new file mode 100644
index 0000000..175f86a
--- /dev/null
+++ b/vanilla/node_modules/xml-name-validator/README.md
@@ -0,0 +1,35 @@
+# 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");
+```