summaryrefslogtreecommitdiff
path: root/alarm/node_modules/xml-name-validator/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
committerMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
commit99c1d9af689e5325f3cf535c4007b3aeb8325229 (patch)
treee663b3c2ebdbd67c818ac0c5147f0ce1d2463cda /alarm/node_modules/xml-name-validator/README.md
parent9871b03912fc28ad38b4037ebf26a78aa937baba (diff)
downloadpluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.gz
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.bz2
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.zip
Update - This is an automated commit
Diffstat (limited to 'alarm/node_modules/xml-name-validator/README.md')
-rw-r--r--alarm/node_modules/xml-name-validator/README.md36
1 files changed, 0 insertions, 36 deletions
diff --git a/alarm/node_modules/xml-name-validator/README.md b/alarm/node_modules/xml-name-validator/README.md
deleted file mode 100644
index eb413f9..0000000
--- a/alarm/node_modules/xml-name-validator/README.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# 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'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.
-
-```js
-"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");
-```