# @rdfjs/serializer-jsonld

> JSON-LD serializer that implements the RDF/JS Sink interface

Latest version **2.0.1** (published 2024-02-10) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 43/100 (D)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-02-10 |
| First published | 2018-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/rdfjs__serializer-jsonld) |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Thomas Bergwinkl |
| Maintainers | bergos |
| Keywords | rdf, rdfjs, serializer, json-ld |

## Links

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

## Dependencies (2)

- [@rdfjs/sink](https://npm.io/package/@rdfjs/sink.md) ^2.0.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^4.5.2

## 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.0.1 (latest) — 2024-02-10
- 2.0.0 — 2022-10-08
- 1.2.3 — 2021-05-10
- 1.2.2 — 2020-04-23
- 1.2.1 — 2019-07-29
- 1.2.0 — 2018-10-10
- 1.1.3 — 2018-09-04

## README

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

JSON-LD serializer that implements the [RDF/JS Sink interface](http://rdf.js.org/).

## Usage

The package exports the serializer 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 serialization.
It expects a quad stream as argument.
The method will return a stream which emits the JSON-LD as a plain object or string.

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

- `encoding`: Defines the encoding of the output.
  Supported encodings are `string` and `object`.
  By default `object` is 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 serializer instance and how to feed it with a stream of quads.
The object emitted by the serializer will be written to the console.

```javascript
import rdf from '@rdfjs/data-model'
import { Readable } from 'readable-stream'
import SerializerJsonld from '@rdfjs/serializer-jsonld'

const serializerJsonld = new SerializerJsonld()
const input = new Readable({
  objectMode: true,
  read: () => {
    input.push(rdf.quad(
      rdf.namedNode('http://example.org/sheldon-cooper'),
      rdf.namedNode('http://schema.org/givenName'),
      rdf.literal('Sheldon')))
    input.push(rdf.quad(
      rdf.namedNode('http://example.org/sheldon-cooper'),
      rdf.namedNode('http://schema.org/familyName'),
      rdf.literal('Cooper')))
    input.push(rdf.quad(
      rdf.namedNode('http://example.org/sheldon-cooper'),
      rdf.namedNode('http://schema.org/knows'),
      rdf.namedNode('http://example.org/amy-farrah-fowler')))
    input.push(null)
  }
})
const output = serializerJsonld.import(input)

output.on('data', jsonld => {
  console.log(jsonld)
})
```

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