# real-experiences-sdk

> TypeScript/JavaScript SDK for interaction with REAL Experiences.

Latest version **0.1.4** (published 2022-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install real-experiences-sdk
pnpm add real-experiences-sdk
yarn add real-experiences-sdk
bun add real-experiences-sdk
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2022-04-28 |
| First published | 2022-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 49.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | REAL |
| Maintainers | bhavish-real |
| Keywords | experience, real |

## Links

- npm: https://www.npmjs.com/package/real-experiences-sdk
- Repository: https://github.com/real-social-media/experience_sdk
- Homepage: https://github.com/real-social-media/experience_sdk#readme
- Issues: https://github.com/real-social-media/experience_sdk/issues
- npm.io page: https://npm.io/package/real-experiences-sdk

## Dependencies (1)

- [yup](https://npm.io/package/yup.md) 0.32.11

## 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

- 0.1.4 (latest) — 2022-04-28
- 0.1.3 — 2022-04-26
- 0.1.2 — 2022-04-26
- 0.1.1 — 2022-04-05
- 0.1.0 — 2022-03-24

## README

# REAL Experiences SDK

TypeScript/JavaScript SDK for interaction with REAL Experience.

## Commands

To run the dev serve
r, use:

```bash
npm start # or yarn start
```

This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.

To do a one-off build, use `npm run build`.

To run tests, use `npm test`.

## Configuration

Code quality is set up with `prettier`, `husky`, and `lint-staged`.

### Jest

Jest tests are set up to run with `npm test`.

### Bundle Analysis

[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of this library with `npm run size` and visualize the bundle with `npm run analyze`.

### Rollup

TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.

## Continuous Integration

### GitHub Actions

The following actions exist:

- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)

## Optimizations

Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:

```js
// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}
```

You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.

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