Introduction

The JavaScript Client Libraries provide a suite of JavaScript Application Programming Interfaces (APIs) to build Solid applications. Solid applications refer to applications that conform to the Solid specifications .

Inrupt’s JavaScript Client Libraries

Inrupt’s JavaScript Client Libraries provide APIs, such as for read/ write/authenticate/access management operations, that conform to the Solid specifications.

Library

Description

solid-client

A client library for accessing data stored in Solid Pods.

solid-client-authn

A set of libraries for authenticating to Solid identity servers:

  • solid-client-authn-browser for use in a browser.

  • solid-client-authn-node for use in Node.js.

solid-client-notifications

A client library for subscribing to change notifications.

Alpha Release

vocab-common-rdf

A library that provides convenience objects for many RDF-related identifiers, such as the Person and familyName identifiers from the Schema.org vocabulary from Google, Microsoft and Yahoo!

vocab-solid-common

A library that provides convenience objects for many Solid-related identifiers.

vocab-inrupt-common

A library that provides convenience objects for Inrupt-related identifiers.

Getting Started

To get started using these libraries, see the following pages in the documentation:

Getting Started: Part 1

Create an application that uses the libraries to read data from your Solid Pod.

Getting Started: Part 2

Create an application that uses the libraries to write data to your Solid Pod.

Browser Support

The JavaScript Client Libraries support the latest 2 stable releases of the following browsers:

Desktop

Google Chrome
Mozilla Firefox
Microsoft Edge
Apple Safari

Mobile

iOS/Safari
Android/Chrome
Android/Samsung Internet

You can use the libraries in the browser with a bundler like Webpack, Rollup, or Parcel.