# realm-web

> Authenticate and communicate with the Atlas App Services, from your web-browser

Latest version **2.0.1** (published 2024-05-30) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install realm-web
pnpm add realm-web
yarn add realm-web
bun add realm-web
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-05-30 |
| First published | 2020-06-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 4 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 6001 |
| Author | MongoDB |
| Maintainers | kraenhansen, realmnpm, kneth, takameyer |
| Keywords | realm, browser |

## Links

- npm: https://www.npmjs.com/package/realm-web
- Repository: https://github.com/realm/realm-js
- Homepage: https://github.com/realm/realm-js/tree/main/packages/realm-web#readme
- Issues: https://github.com/realm/realm-js/issues
- npm.io page: https://npm.io/package/realm-web

## Dependencies (4)

- [bson](https://npm.io/package/bson.md) ^4.5.4
- [js-base64](https://npm.io/package/js-base64.md) ^3.7.6
- [@realm/common](https://npm.io/package/@realm/common.md) ^0.1.4
- [detect-browser](https://npm.io/package/detect-browser.md) ^5.2.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-05-30
- 2.0.0 — 2022-10-18
- 1.7.1 — 2022-07-04
- 1.7.0 — 2022-02-14
- 1.6.0 — 2022-01-26
- 1.5.1 — 2021-11-17
- 1.5.0 — 2021-11-11
- 1.4.0 — 2021-10-18
- 1.3.0 — 2021-05-27
- 1.2.1 — 2021-02-17
- 1.2.0 — 2021-01-11
- 1.1.0 — 2020-12-08
- 1.0.0 — 2020-10-16
- 1.0.0-rc.2 — 2020-10-13
- 1.0.0-rc.1 — 2020-10-09
- … 9 more at https://npm.io/package/realm-web/versions

## README

# Realm Web

Accessing Atlas App Services from a web-browser.

## Documentation

Visit [mongodb.com/docs/atlas/device-sdks/web/](https://www.mongodb.com/docs/atlas/device-sdks/web/) for quick guides on getting started and examples on how to use it.

We're not publishing documentation explicitly for this SDK, but we aim to align names and method signatures identical for the subset of functionality in Realm Web which is also available in the Realm JS SDK. For this reason, the [mongodb.com/docs/realm-sdks/js/latest/](https://www.mongodb.com/docs/realm-sdks/js/latest/) is a great start to learn about the classes and methods provided by the Realm Web SDK.

## Installation

Via NPM, when used in a project with a bundler, such as Webpack, Parcel or Rollup:

```
npm install realm-web
```

As a script-tag in the head of a browser:

```html
<script src="https://unpkg.com/realm-web@2.0.0"></script>
```

## Caveats / limitations

- The Realm Web project *will not* include a Realm Sync client in any foreseeable future. Use the `realm` package to use Realm Sync from a Node.js, ReactNative or Electron environment.
- A limited selection of [app services](https://www.mongodb.com/docs/atlas/app-services/mongodb/) are implemented at the moment:
  - MongoDB: Read, write and watch MongoDB documents.

<!--
## Using Realm Web in a Node.js environment

You must install two additional dependencies when importing this package from Node.js:

```
npm install node-fetch abort-controller
```
-->

---
_Source: https://npm.io/package/realm-web · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._