0.5.4 • Published 7 years ago

@sabbatical/document-database v0.5.4

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

document-database-if

Interface to a generic document (no-SQL) database.
See the DocumentDatabase type in the declarations file.

adaptors

  • InMemoryDB
    An in-memory database, that doesn't persist its data.
    This is great for testing.
  • MongoDBApaptor
    For use with a mongoDB database, using mongoose.js for schema enforcement.
    We use this for initial databases.

tests

There are tests for this interface in the tests sub-package, that can be configured for use with any DocumentDatabase-compliant object.

To use these tests for you own database adaptor, install these packages to your database adaptor package:

  • chai
  • mocha
  • @sabbatical/document-database/tests

and add these dependencies to the compilerOptions.types field of your tsconfig.json file:

    "compilerOptions": {
        "types" : ["chai", "mocha", "@psnider/document-database/tests"]