digitalbazaar/rdf-canonize

Name: rdf-canonize

Owner: Digital Bazaar, Inc.

Description: An implementation of the RDF Dataset Normalization Algorithm in JavaScript

Created: 2016-02-15 20:04:58.0

Updated: 2017-08-16 00:45:50.0

Pushed: 2017-12-05 18:59:16.0

Homepage: null

Size: 155

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

rdf-canonize

Build status Dependency Status

An implementation of the RDF Dataset Normalization Algorithm in JavaScript.

Introduction

Installation
node.js + npm
install rdf-canonize
s
t canonize = require('rdf-canonize');
Browser (AMD) + npm
install rdf-canonize

Use your favorite technology to load node_modules/dist/rdf-canonize.min.js.

HTML

Various NPM proxy CDN sites offer direct access to NPM files.

Examples
t dataset = {
 ...


anonize a data set with a particular algorithm
nize.canonize(dataset, {algorithm: 'URDNA2015'}, function(err, canonical) {
 ...

Related Modules
Tests

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
Benchmark

See docs in the benchmark README.

Source

The source code for this library is available at:

https://github.com/digitalbazaar/rdf-canonize

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: support@digitalbazaar.com


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.