Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

brightid_sdk

acolytec32921.0.1TypeScript support: included

A typescript library for simplifying integration of applications with BrightID

typescript, brightid

readme

BrightID SDK for Applications

A typescript library for simplifying integration of applications with BrightID

🎉 Features

Exposes all necessary functions for integrating an application with BrightID as well as testing methods to make sure its all working.

⚙ Install

# npm
npm i brightid_sdk

📖 Docs

You can read docs here, just remember to run the npm run docs script.

Contributing

PRs always welcome!

Predefined scripts in package.json:

  • changelog: creates a changelog (using standard-changelog)
  • docs: creates docs from your jsdocs
  • lint: lints your code
  • prepublishOnly: builds your sources for deployment (to npm)
  • size-limit: checks your bundle size limit
  • test: run tests
  • upgrade-interactive: upgrades your dependencies interactively (like with yarn)

    📃 Licence

Read the licence

changelog

1.0.1 (2020-12-14)

Features

  • Add complete documentation of exported methods

1.0.0 (2020-12-14)

Features

  • Add better return messaging for all methods

0.0.2 (2020-12-14)

Features

  • Return better error messaging when a function call fails