Skip to content

JS SDK overview

The main JavaScript package is @barq/barq.

It provides:

  • Barq.open()
  • object schemas
  • write transactions
  • query results
  • listeners
  • value types under Barq.Types
  • sync users through Barq.User.fromToken()
Terminal window
bun add @barq/barq
import Barq from '@barq/barq';

Barq ships its own value types. It does not require a third-party BSON package.

  • Barq.Types.ObjectId
  • Barq.Types.UUID
  • Barq.Types.Decimal128
  • Barq.Types.Binary
  • Barq.Types.EJSON