@inrupt/solid-client-notifications

Solid Notifications - solid-client-notifications

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [e-mail].

@inrupt/solid-client-notifications is a Javascript library for subscribing to notifications. It allows your application to subscribe to resources, receiving events as resources change. You can use these in Node.js using either CommonJS or ES modules, and in the browser with a bundler like Webpack, Rollup, or Parcel.

@inrupt/solid-client-notifications is part of a family open source JavaScript libraries designed to support developers building Solid applications.

Supported environments

Our JavaScript Client Libraries use relatively modern JavaScript, aligned with the ES2018 Specification features, we ship both ESM and CommonJS, with type definitions for TypeScript alongside.

This means that out of the box, we only support environments (browsers or runtimes) that were released after mid-2018, if you wish to target other (older) environments, then you will need to cross-compile our SDKs via the use of Babel, webpack, SWC, or similar.

If you need support for Internet Explorer, it is recommended to pass them through a tool like Babel, and to add polyfills for e.g. Map, Set, Promise, Headers, Array.prototype.includes, Object.entries and String.prototype.endsWith.

Node.js Support

Our JavaScript Client Libraries track Node.js LTS releases, and support 16.x, 18.x and 20.x.

Installation

For the latest stable version of solid-client-notifications:

npm install @inrupt/solid-client-notifications

For the latest stable version of all Inrupt Solid JavaScript libraries:

npm install @inrupt/solid-client @inrupt/solid-client-authn-browser @inrupt/vocab-common-rdf @inrupt/solid-client-notifications

Issues & Help

Solid Community Forum

If you have questions about working with Solid or just want to share what you’re working on, visit the Solid forum. The Solid forum is a good place to meet the rest of the community.

Bugs and Feature Requests

• For public feedback, bug reports, and feature requests please file an issue via Github.
• For non-public feedback or support inquiries please use the Inrupt Service Desk.

Documentation

• Subscribe to WebSocket Notifications
• Inrupt Solid Javascript Client Libraries
• Homepage

Changelog

See the release notes.

License

MIT © Inrupt