An implementation of the RDF Dataset Normalization Algorithm in JavaScript.
...
npm install rdf-canonize
const canonize = require('rdf-canonize');
NOTE: This package has an optional dependency on rdf-canonize-native.
If native build tools are not available then the native bindings will fail to
build and only the JavaScript implementation will be used. If you wish to
ensure you get the higher performance of the native code, and want to ensure
build failures will not be ignored, then you should also add a dependency on
rdf-canonize-native
to your project.
npm install rdf-canonize
npm install rdf-canonize-native
Note that the native code will automatically be used if available.
const canonize = require('rdf-canonize');
npm install rdf-canonize
Use your favorite technology to load node_modules/dist/rdf-canonize.min.js
.
Various NPM proxy CDN sites offer direct access to NPM files.
const dataset = {
// ...
};
// canonize a data set with a particular algorithm
canonize.canonize(dataset, {algorithm: 'URDNA2015'}, function(err, canonical) {
// ...
});
This library includes a sample testing utility which may be used to verify that changes to the processor maintain the correct output.
The test suite is included in an external repository:
https://github.com/json-ld/normalization
This should be a sibling directory of the rdf-canonize directory or in a
test-suites
dir. To clone shallow copies into the test-suites
dir you can
use the following:
npm run fetch-test-suite
Node.js tests can be run with a simple command:
npm test
If you installed the test suites elsewhere, or wish to run other tests, use
the TEST_DIR
environment var:
TEST_DIR="/tmp/tests" npm test
To generate earl reports:
# generate the earl report for node.js
EARL=earl-node.jsonld npm test
See docs in the benchmark README.
The source code for this library is available at:
https://github.com/digitalbazaar/rdf-canonize
Commercial support for this library is available upon request from Digital Bazaar: support@digitalbazaar.com