npm package: @inrupt/solid-client-notifications
Description: Receive notifications linked to Solid resources.
Latest version: 4.0.0

# Solid Notifications - solid-client-notifications

[![Contributor
Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE-OF-CONDUCT.md)

This project adheres to the Contributor Covenant [code of
conduct](CODE-OF-CONDUCT.md). By participating, you are expected to uphold this
code. Please report unacceptable behavior to
[engineering@inrupt.com](mailto:engineering@inrupt.com).

@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](https://262.ecma-international.org/9.0/) Specification features, we
ship both [ESM](https://nodejs.org/docs/latest-v16.x/api/esm.html) and
[CommonJS](https://nodejs.org/docs/latest-v16.x/api/modules.html), 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](https://babeljs.io), [webpack](https://webpack.js.org/),
[SWC](https://swc.rs/), or similar.

If you need support for Internet Explorer, it is recommended to pass them
through a tool like [Babel](https://babeljs.io), and to add polyfills for e.g.
`Map`, `Set`, `Promise`, `Headers`, `Array.prototype.includes`, `Object.entries`
and `String.prototype.endsWith`.

### Node.js Support

See [Inrupt Solid Javascript Client
Libraries](https://docs.inrupt.com/sdk/javascript-sdk#node.js-support).

## Installation

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

```bash
npm install @inrupt/solid-client-notifications
```

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

```bash
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](https://forum.solidproject.org/). 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](https://github.com/inrupt/solid-client-notifications-js/issues/).
- For non-public feedback or support inquiries please use the [Inrupt Service
  Desk](https://inrupt.atlassian.net/servicedesk).

### Documentation

- [Subscribe to WebSocket
  Notifications](https://docs.inrupt.com/sdk/javascript-sdktutorial/subscribe-to-notifications/)
- [Inrupt Solid Javascript Client
  Libraries](https://docs.inrupt.com/sdk/javascript-sdk)
- [Homepage](https://docs.inrupt.com/)

## Changelog

See [the release
notes](https://github.com/inrupt/solid-client-notifications-js/blob/main/CHANGELOG.md).

## License

MIT © [Inrupt](https://inrupt.com)