# @rdfjs/serializer-jsonld-ext

> JSON-LD serializer that implements the RDF/JS Sink interface and supports different output styles

Latest version **4.0.2** (published 2025-11-23) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.0.2 |
| Published | 2025-11-23 |
| First published | 2019-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/rdfjs__serializer-jsonld-ext) |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.4 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-ext
- Repository: https://github.com/rdfjs-base/serializer-jsonld-ext
- Issues: https://github.com/rdfjs-base/serializer-jsonld-ext/issues
- npm.io page: https://npm.io/package/@rdfjs/serializer-jsonld-ext

## Dependencies (4)

- [jsonld](https://npm.io/package/jsonld.md) ^9.0.0
- [@rdfjs/sink](https://npm.io/package/@rdfjs/sink.md) ^2.0.1
- [stream-chunks](https://npm.io/package/stream-chunks.md) ^1.0.0
- [readable-stream](https://npm.io/package/readable-stream.md) ^4.7.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

- 4.0.2 (latest) — 2025-11-23
- 4.0.1 — 2025-03-02
- 4.0.0 — 2023-02-17
- 3.0.0 — 2021-11-16
- 2.0.0 — 2019-07-29

## README

# @rdfjs/serializer-jsonld-ext

[![build status](https://img.shields.io/github/actions/workflow/status/rdfjs-base/serializer-jsonld-ext/test.yaml?branch=master)](https://github.com/rdfjs-base/serializer-jsonld-ext/actions/workflows/test.yaml)

[![npm version](https://img.shields.io/npm/v/@rdfjs/serializer-jsonld-ext.svg)](https://www.npmjs.com/package/@rdfjs/serializer-jsonld-ext)

JSON-LD serializer that implements the [RDF/JS Sink interface](http://rdf.js.org/stream-spec/#sink-interface) and supports different output styles.
This package handles the stream processing and uses [jsonld.js](https://github.com/digitalbazaar/jsonld.js) for the actual serialization process. 

## 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:

- `baseIRI`: A base IRI given as `NamedNode`, `URL`, or string object.
- `context`: JSON-LD context that will be used for compact, flatten or frame.
  The context must be given as a plain object.
  By default `{}` is used.
- `compact`: If this flag is `true`, the jsonld.js compact will be used to process the output. 
- `flatten`: If this flag is `true`, the jsonld.js flatten will be used to process the output.
- `frame`: If this flag is `true`, the jsonld.js frame will be used to process the output.
- `skipContext`: Removes the `@context` property from the output.
  Useful for HTTP server when the media type `application/json` is used and a context is provided as header link. 
- `encoding`: Defines the encoding of the output.
  Supported encodings are `string` and `object`.
  By default `object` is used.
- `prettyPrint`: Enables pretty printing for string encoding.

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 output will be processed with `compact` using the given context and baseIRI.
The string 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-ext'

const context = {
  '@vocab': 'http://schema.org/'
}

const serializerJsonld = new SerializerJsonld({
  baseIRI: 'http://example.org/',
  context,
  compact: true,
  encoding: 'string',
  prettyPrint: true
})

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)
})

/* output:

{
  "@context": {
    "@vocab": "http://schema.org/",
    "@base": "http://example.org/"
  },
  "@id": "sheldon-cooper",
  "familyName": "Cooper",
  "givenName": "Sheldon",
  "knows": {
    "@id": "amy-farrah-fowler"
  }
}
*/
```

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