Pod | @polypoly-eu/api

The polyPod API, exposed to Features as window.pod.

It consists of multiple components that are concerned with different aspects.

To use the API, a Feature needs to load the pod.js file provided by the polyPod:

<script src="pod.js"></script>

This makes the window.pod object available, which holds all the components listed below. For example, to log the name of the polyPod runtime:

console.log(await window.pod.info.getRuntime());

Index

dataFactory: DataFactory<Quad, Quad>

An implementation of RDF/JS' DataFactory used in conjunction with PolyIn.

endpoint: Endpoint

Allows Features to exchange data with external servers.

info: Info

Allows Features to read information about the polyPod instance they are being executed in.

polyIn: PolyIn

Offers access to the polyPod's internal triplestore.

polyNav: PolyNav

Allows Features to interact with the user outside the confines of their container.

polyOut: PolyOut

Allows Features to store data on a virtual file system not accessible to other Features.

triplestore: Triplestore

An experimental replacement for PolyIn.