https://github.com/gbv/jsonld2rdf

Convert JSON-LD to N-Triples or Turtle.
https://github.com/gbv/jsonld2rdf

Last synced: 3 months ago
JSON representation

Convert JSON-LD to N-Triples or Turtle.

• Host: GitHub
• URL: https://github.com/gbv/jsonld2rdf
• Owner: gbv
• License: mit
• Created: 2024-08-29T14:35:10.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-02T07:35:05.000Z (4 months ago)
• Last Synced: 2024-11-06T00:19:10.909Z (3 months ago)
• Language: JavaScript
• Size: 116 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jsonld2rdf

> Convert JSON-LD to N-Triples or Turtle

[![Test](https://github.com/gbv/jsonld2rdf/actions/workflows/test.yml/badge.svg)](https://github.com/gbv/jsonld2rdf/actions/workflows/test.yml)

[![NPM Version](http://img.shields.io/npm/v/jsonld2rdf.svg?style=flat)](https://www.npmjs.org/package/jsonld2rdf)

This package provides a command line client to convert JSON-LD files into N-Triples or Turtle syntax.

## Table of Contents

- [Background](#background)

- [Install](#install)

- [Usage](#usage)

  - [Command line interface](#command-line-interface)

  - [API](#api)

- [See Also](#see-also)

## Install

~~~sh

npm install -g jsonld2rdf

~~~

## Usage

### Command line interface

~~~sh

Usage: jsonld2rdf [options] [file...]

Convert JSON-LD to N-Triples or Turtle.

Arguments:

  file                   JSON-LD input file

Options:

  -c, --context    JSON-LD context document

  -p, --prefixes   RDF Prefix map (as JSON object) for Turtle output

  -n, --ndjson           input is newline delimited JSON

  -h, --help             display help for command

~~~

Reads from standard input by default or when file name is `-`. Input can be

a JSON object, an array of JSON objects or newline-delimited JSON. Each JSON

object ist converted. Option `context` overrides an possibly existing field

`@context`.

For example this JSON file `example.json`

~~~json

{

  "id": "my:id",

  "title": "test"

}

~~~

with this context document `context.json`

~~~json

{

  "title": "http://purl.org/dc/terms/title",

  "id": "@id"

}

~~~

converted with `jsonld2rdf -c context.json example.json` to

~~~ttl

  "test" .

~~~

With an additional prefixes file `prefixes.json`

~~~

{

  "dct": "http://purl.org/dc/terms/"

}

~~~

it is converted with `jsonld2rdf -c context.json -p prefixes.json example.json` to

~~~ttl

@prefix dct:  .

 dct:title "test" .

~~~

### API

Function `jsonld2rdf` expects a JSON object, a file name, or an array of file

names and/or JSON objects to transform. File name `-` can be used for standard

input and files ending with `.ndjson` or `.jsonl` are read as newline delimited

JSON. The second argument is a options object with optional fields `context`

and `prefixes` as JSON objects. Additional option field `ndjson` can be used to

enforce reading input files as newline delimited JSON instead of plain JSON.

The function returns a Turtle string if `prefixes` have been given or N-Triples

otherwise.

~~~js

import { jsonld2rdf } from "jsonld2rdf"

const nt = jsonld2rdf(["file.json"], { context })

const ttl = jsonld2rdf(["file.json"], { context, prefixes })

~~~

## See Also

Implementation is based on package [@digitalcredentials/jsonld](https://www.npmjs.com/package/@digitalcredentials/jsonld). Depending on your use case you may better directly use it.

Similar packages include [jsonld-cli](https://www.npmjs.com/package/jsonld-cli) and [ndjsonld](https://www.npmjs.com/package/ndjsonld]).