@rdfjs/parser-jsonld

@rdfjs/parser-jsonld

JSON-LD parser that implements the RDF/JS Sink interface using jsonld-streaming-parser.

Usage

Use the following command to add the package as a dependency to your project:

npm install @rdfjs/data-model --save

The package exports the parser as a class, so an instance must be created before it can be used. The .import method, as defined in the RDF/JS specification, must be called to do the actual parsing. It expects a JSON string stream or a stream which emits a single object. The method will return a stream which emits the parsed quads.

The constructor accepts an options object with the following optional keys:

• baseIRI: Allows passing the base IRI manually to the jsonld-streaming-parser library.
• context: Allows passing a JSON-LD context manually to the jsonld-streaming-parser library.
• factory: Use an alternative RDF/JS data factory. By default the reference implementation us used.

It's also possible to pass options as second argument to the .import method. The options from the constructor and the .import method will be merged together.

Example

This example shows how to create a parser instance and how to feed it with a stream from a string. The parsed quads are written to the console.

const ParserJsonld = require('@rdfjs/parser-jsonld')
const Readable = require('stream').Readable

const parserJsonld = new ParserJsonld()

const input = new Readable({
  read: () => {
    input.push(`{
      "@context": "http://schema.org/",
      "@type": "Person",
      "name": "Jane Doe",
      "jobTitle": "Professor",
      "telephone": "[phone]",
      "url": "http://www.janedoe.com"
    }`)
    input.push(null)
  }
})

const output = parserJsonld.import(input)

output.on('data', quad => {
  console.log(`${quad.subject.value} - ${quad.predicate.value} - ${quad.object.value}`)
})