real-experiences-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

REAL Experiences SDK

TypeScript/JavaScript SDK for interaction with REAL Experience.

Commands

To run the dev serve r, use:

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 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 as a bundler and generates multiple rollup configs for various module formats and build settings. See 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

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./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 and warning functions.

/real-experiences-sdk/

    Package Sidebar

    Install

    npm i real-experiences-sdk

    Weekly Downloads

    1

    Version

    0.1.4

    License

    MIT

    Unpacked Size

    50.7 kB

    Total Files

    21

    Last publish

    Collaborators

    • bhavish-real