Adding rs.js to an app

rs.js is distributed as a single UMD build, which means it should work with all known JavaScript module systems, as well as without one (using a global variable).

We recommend adding the library from a JavaScript package manager, although you may also just download the release build from GitHub.

The package is available on npm as remotestoragejs:

npm

$ npm add -D remotestoragejs

pnpm

$ pnpm add -D remotestoragejs

yarn

$ yarn add -D remotestoragejs

bun

$ bun add -D remotestoragejs

Examples

ES6 module

import RemoteStorage from 'remotestoragejs';

CommonJS module

var RemoteStorage = require('remotestoragejs');

AMD module

For example with RequireJS:

requirejs.config({
  paths: {
    RemoteStorage: './lib/remotestorage'
  }
});

requirejs(['RemoteStorage'], function(RemoteStorage) {
  // Here goes my app
});

No module system

If you just link the build from HTML, it will add RemoteStorage as a global variable to window.

<script type="text/javascript" src="remotestorage.js"></script>