FaunaDB JS Driver Reference Documentation

See the README and the Official FaunaDB Documentation for examples and tutorials.

Required Classes and Modules

  • Client: Instances of this Class are used to communicate with FaunaDB.
  • query module: Contains functions used to build FaunaDB Query expressions.

Other Classes and Modules

  • PageHelper: A helper Class to provide a simpler API for consuming paged responses.
  • errors module: Contains exception classes thrown by Client instances and query functions.
  • clientLogger module: Contains functions used to easily create debug logging and observer callbacks.
  • RequestResult: A container structure provided to observers registered in Client instances.

Internal types and modules

  • Expr: A base class for FaunaDB expression types.
  • values module: Class hierarchy for FaunaDB value types.