JSPM

  • Created
  • Published
  • Downloads 82
  • Score
    100M100P100Q88464F
  • License MIT

Vite-compatible builds for ShareDB and OT types

Package Exports

  • sharedb-client-browser/dist/ot-json1-presence-umd.cjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sharedb-client-browser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sharedb-client-browser

A distribution of the ShareDB client suitable for use in Vite, Rollup and other build tools that do not have built-in support for CommonJS and Node polyfills. Uses the venerable Browserify.

There are 3 UMD builds provided:

  • sharedb-client-umd.cjs Just the ShareDB client
  • ot-json1-presence-umd.cjs Includes ot-json1 and text-unicode (both exposed to avoid duplication of text-unicode in a bundle where application logic needs direct access to it)
  • ot-json1-umd.cjs Includes ot-json1 and text-unicode

In order to work properly, the consuming

The consuming project needs to put the following in the Vite config (modify depending on which builds you need):

  // Required to have Vite properly handle these CommonJS imports
  optimizeDeps: {
    include: [
      'sharedb-client-browser/dist/sharedb-client-umd.cjs',
      'sharedb-client-browser/dist/ot-json1-presence-umd.cjs'
    ]
  },

See also