# previolet

> Previolet Javascript SDK

Latest version **1.1.7** (published 2023-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install previolet
pnpm add previolet
yarn add previolet
bun add previolet
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2023-11-09 |
| First published | 2020-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 554.2 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark Simons |
| Maintainers | msimons9740 |
| Keywords | previolet, authentication, database, storage, remote-config |

## Links

- npm: https://www.npmjs.com/package/previolet
- Repository: https://github.com/previolet/previolet-js-sdk
- Homepage: https://github.com/previolet/previolet-js-sdk#readme
- Issues: https://github.com/previolet/previolet-js-sdk/issues
- npm.io page: https://npm.io/package/previolet

## Dependencies (5)

- [md5](https://npm.io/package/md5.md) ^2.3.0
- [axios](https://npm.io/package/axios.md) ^0.21.4
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.20.12
- [@rollup/plugin-babel](https://npm.io/package/@rollup/plugin-babel.md) ^5.3.1
- [@babel/plugin-proposal-object-rest-spread](https://npm.io/package/@babel/plugin-proposal-object-rest-spread.md) ^7.13.8

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@oxyhq/services](https://npm.io/package/@oxyhq/services.md) — 2.3K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads

## Recent versions

- 1.1.7 (latest) — 2023-11-09
- 1.1.6 — 2023-11-03
- 1.1.5 — 2023-11-03
- 1.1.4 — 2022-05-22
- 1.1.3 — 2022-05-22
- 1.1.2 — 2022-05-20
- 1.1.1 — 2022-05-19
- 1.1.0 — 2022-05-19
- 1.0.50 — 2021-11-15
- 1.0.49 — 2021-10-11
- 1.0.48 — 2021-09-17
- 1.0.47 — 2021-09-17
- 1.0.46 — 2021-09-17
- 1.0.45 — 2021-09-17
- 1.0.44 — 2021-09-17
- … 41 more at https://npm.io/package/previolet/versions

## README

# Previolet

[Previolet][home] provides the interface, infrastructure and tools you need to build, manage and grow your application. Featuring a realtime database, powerful authentication and cloud functions, teams also use Previolet to organize their work.

This SDK is intended for end-user client access for Web, mobile Web (e.g. React Native, VueJs, Angular), Node.js desktop or IoT devices.

## Get the code

### NPM bundler

The Previolet JavaScript npm package contains code that can be run in the browser after combining the modules you use with a package bundler.

Install the Previolet npm module:

```
$ npm init
$ npm install --save previolet
```

In your code, you can initialize the SDK using:

```js
var PrevioletSDK = require('previolet').default
var sdk = new PrevioletSDK({
  instance: 'cXXXXXXXX',
  region: 'eu.west1',           // Application region (optional)
  tokenFallback: 'tk-XXXXXXXX', // Persistent token (optional)
  appVersion: '1.0.0',          // Your custom app version (optional)
})
```

### Script include

Include Previolet in your web application via a `<script>` tag:

```html
<body>
  <script src="https://cdn.jsdelivr.net/npm/previolet/dist/previolet-sdk.min.js"></script>

  <script>
    // Initialize Previolet
    var sdk = new PrevioletSDK({ ... })
  </script>
</body>
```

[home]: https://previolet.com

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