mega-couch

A Couchdb library for NodeJS written in typescript

Why? Because nano couch and nanoAsync are hard to work with in modern async/await syntax. CouchDB is a very powerful database at it must have a proper library to connect and consume

Objectives

• use only the axios library as dependency
• user has the ability to abort, cancel a ongoing request
• user has the ability to set a timeout
• developer can run bulk commands on multiple databases
• full support for sync, replicate, cluster commands
• ability to migrate documents only by bulk writing
• full support for design docs, view docs, update docs
• ability to select couchdb or couchbase as a connector or connect to both
• support websockets for _changes
• have both Promise and Observable as reponse types (function name example: db.get() and db.get$() -- where $ marks the observable)
• add dev friendly functions: databaseExists, dbCreate... etc
• add fail/silent to friendly functions: dbCreate // dbCreateOrThrow // dbCreateNoFail
• chain friendly query for params ex: limit(100).heartbeat(5000).descending().ids([])
• query, _find, _list functions MUST respond in the same format
• list has it's on QueryList with chained params: limit(12).skip(14)...
• _design doc firendly listing/viewing/query. Exclude all system docs that start with _
• add a reserved prefix for doc id so we make our own system docs (can't use _)

Extras:

• add a migration object to define databases that we ensure exist
• add design and view docs
• add indexes

Publish to npm and create a nestjs plugin as well

Will be Made with ❤️ by naologic in 🇺🇸 San Francisco