Installation

BlinkDB is not production ready yet. Proceed with caution, and head on over to the ”Future plans” page to see what awaits BlinkDB in the future.

The easiest way to get started with BlinkDB is to install it in your project with Yarn:

yarn add blinkdb

If you prefer NPM, you can instead use

npm i blinkdb

Configure TS

While it isn’t strictly necessary, in order to ensure complete type safety, set the following fields in your tsconfig.json:

{
  ... ,
  "compilerOptions": {
    ... ,
    // Enables `exactOptionalPropertyTypes`
    "strictNullChecks": true,
    // Prevents you from updating entity fields with `undefined`
    "exactOptionalPropertyTypes": true
  },
}