diff options
author | Minteck <contact@minteck.org> | 2022-10-18 08:59:09 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-10-18 08:59:09 +0200 |
commit | 2c4ae43e688a9873e86211ea0e7aeb9ba770dd77 (patch) | |
tree | 17848d95522dab25d3cdeb9c4a6450e2a234861f /alarm/node_modules/xml-name-validator/README.md | |
parent | 108525534c28013cfe1897c30e4565f9893f3766 (diff) | |
download | pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.gz pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.bz2 pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.zip |
Update
Diffstat (limited to 'alarm/node_modules/xml-name-validator/README.md')
-rw-r--r-- | alarm/node_modules/xml-name-validator/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/alarm/node_modules/xml-name-validator/README.md b/alarm/node_modules/xml-name-validator/README.md new file mode 100644 index 0000000..eb413f9 --- /dev/null +++ b/alarm/node_modules/xml-name-validator/README.md @@ -0,0 +1,36 @@ +# 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"); +``` |