@rdfjs/parser-jsonld - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "@rdfjs/parser-jsonld",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "JSON-LD parser that implements the RDFJS Sink interface using jsonld.js",
@@ -11,3 +11,3 @@ "main": "index.js",
     "type": "git",
-    "url": "git://github.com/rdfjs/parser-jsonld.git"
+    "url": "git://github.com/rdfjs-base/parser-jsonld.git"
   },
@@ -23,5 +23,5 @@ "keywords": [
   "bugs": {
-    "url": "https://github.com/rdfjs/parser-jsonld/issues"
+    "url": "https://github.com/rdfjs-base/parser-jsonld/issues"
   },
-  "homepage": "https://github.com/rdfjs/parser-jsonld",
+  "homepage": "https://github.com/rdfjs-base/parser-jsonld",
   "dependencies": {
@@ -28,0 +28,0 @@ "@rdfjs/data-model": "^1.0.1",

README.md

@@ -8,1 +8,50 @@ # @rdfjs/parser-jsonld
 JSON-LD parser that implements the [RDFJS Sink interface](http://rdf.js.org/) using [jsonld.js](https://github.com/digitalbazaar/jsonld.js).
+
+## Usage
+
+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 [RDFJS specification](http://rdf.js.org/#sink-interface), 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.js` library.
+- `context`: Allows passing a JSON-LD context manually to the `jsonld.js` library.
+- `factory`: Use an alternative RDFJS data factory.
+  By default the [reference implementation](https://github.com/rdfjs-base/data-model/) 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.
+
+```javascript
+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}`)
+})
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17683

increased by10.8%

Number of lines in readme file

57

increased by612.5%

No dependency changes