# @rdfjs/parser-jsonld

> JSON-LD parser that implements the RDFJS Sink interface using jsonld.js

Latest version **2.1.3** (published 2025-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rdfjs/parser-jsonld
pnpm add @rdfjs/parser-jsonld
yarn add @rdfjs/parser-jsonld
bun add @rdfjs/parser-jsonld
```

## Health

**Score 53/100 (C)** — status: stable.

Positive: has types package; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2025-01-10 |
| First published | 2018-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/rdfjs__parser-jsonld) |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 20.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Thomas Bergwinkl |
| Maintainers | bergos |
| Keywords | rdf, rdfjs, parser, jsonld |

## Links

- npm: https://www.npmjs.com/package/@rdfjs/parser-jsonld
- Repository: https://github.com/rdfjs-base/parser-jsonld
- Issues: https://github.com/rdfjs-base/parser-jsonld/issues
- npm.io page: https://npm.io/package/@rdfjs/parser-jsonld

## Dependencies (5)

- [duplex-to](https://npm.io/package/duplex-to.md) ^2.0.0
- [@rdfjs/sink](https://npm.io/package/@rdfjs/sink.md) ^2.0.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^4.5.2
- [@rdfjs/data-model](https://npm.io/package/@rdfjs/data-model.md) ^2.0.2
- [jsonld-streaming-parser](https://npm.io/package/jsonld-streaming-parser.md) ^5.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.1.3 (latest) — 2025-01-10
- 2.1.2 — 2024-10-13
- 2.1.1 — 2024-02-10
- 2.1.0 — 2022-11-09
- 2.0.0 — 2022-10-06
- 1.3.1 — 2022-04-12
- 1.3.0 — 2022-02-27
- 1.2.2 — 2021-11-16
- 1.2.1 — 2020-04-23
- 1.2.0 — 2019-12-01
- 1.1.2 — 2019-07-29
- 1.1.1 — 2018-09-04

## README

# @rdfjs/parser-jsonld
[![build status](https://img.shields.io/github/actions/workflow/status/rdfjs-base/parser-jsonld/test.yaml?branch=master)](https://github.com/rdfjs-base/parser-jsonld/actions/workflows/test.yaml)
[![npm version](https://img.shields.io/npm/v/@rdfjs/parser-jsonld.svg)](https://www.npmjs.com/package/@rdfjs/parser-jsonld)

JSON-LD parser that implements the [RDF/JS Sink interface](http://rdf.js.org/) using [jsonld-streaming-parser](https://github.com/rubensworks/jsonld-streaming-parser.js).

## Usage

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

```bash
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](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-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](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
import ParserJsonld from '@rdfjs/parser-jsonld'
import { Readable } from 'stream'

const parserJsonld = new ParserJsonld()

const input = new Readable({
  read: () => {
    input.push(`{
      "@context": "http://schema.org/",
      "@type": "Person",
      "name": "Jane Doe",
      "jobTitle": "Professor",
      "telephone": "(425) 123-4567",
      "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}`)
})
```

---
_Source: https://npm.io/package/@rdfjs/parser-jsonld · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._