Skip to content

zazuko/clownface

Repository files navigation

clownface

Build Status NPM Version

Clownface is a graph traversal library inspired by Gremlin which allows to query any RDF dataset in a concise and readable way.

Clownface greatly simplifies interacting with RDF data in JavaScript.

Quick start

The recommended way is to use clownface with and RDF/JS environment. It also requires DataFactory and DatasetFactory, for example those provided by @rdfjs/data-model and @rdfjs/dataset packages respectively, as well as @rdfjs/namespace.

npm install clownface @rdfjs/environment @rdfjs/data-model @rdfjs/dataset @rdfjs/namespace
import Environment from '@rdfjs/environment/Environment.js'
import NamespaceFactory from '@rdfjs/namespace/Factory.js'
import DatasetFactory from '@rdfjs/dataset/Factory.js'
import DataFactory from '@rdfjs/data-model/Factory.js'
import ClownfaceFactory from 'clownface/Factory.js'

const $rdf = new Environment([
  NamespaceFactory,
  DatasetFactory,
  DataFactory,
  ClownfaceFactory
])

const graph = $rdf.clownface()

Alternatively, if you already use @zazuko/env, it comes bundled with clownface and its dependencies.

import $rdf from '@zazuko/env'

const graph = $rdf.clownface()

Learn more

If you are new to RDF and JavaScript, consider our Getting Started guide that also covers Clownface basics.

For API documentation and examples, see http://zazuko.github.io/clownface/.