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

Package detail

pouchdb-nextjs-router

jpbourgeon9MIT1.0.0-beta.7

A next.js API submodule with a CouchDB style REST interface to PouchDB

pouchdb, next.js, router

readme

pouchdb-nextjs-router

A next.js API submodule with a CouchDB style REST interface to PouchDB

live the code Github workflow status Version

pouchdb-nextjs-router is a routing module that provides the minimal API to add a PouchDB HTTP endpoint to a next.js application. It features a powerful middleware system that allows you to customize its behaviour without hacking into the module.

It is designed to be mounted into a next.js API route to provide an extensible endpoint for PouchDB instances to sync with.

The code is forked from https://github.com/pouchdb/pouchdb-express-router.

I wrote this module because pouchdb-express-router simply doesn't work inside nextjs beyond the basic paths, and fails to pass the whole pouchdb testsuite.

The module is fully functional but has not been widely used in production yet.

Installation

Install with your favorite package manager.

npm install --save pouchdb-nextjs-router

Documentation

  1. Basic usage
  2. Advanced usage, with middleware
  3. Setup the development environment
  4. Performance
  5. Testing

The repo is actually a next.js app that uses pouchdb-nextjs-router in various API routes for testing. See the code for :

  1. a basic example.
  2. an advanced example with middleware.

Contributing

Pull requests are welcome.

  • For major changes, please open an issue first to discuss what you would like to change.
  • Your pull request name must respect the @commitlint/config-conventional syntax.
  • Your pull request must pass the latest full pouchdb test suite, the router own test suite and provide it own relevant integration tests.

More info

changelog

Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

v1.0.0-beta.7

21 April 2021

  • feat: middleware
  • chore: switch to vscode dev container
  • refactor: prepare router for middleware

v1.0.0-beta.6

21 March 2021

  • feat: handle url trailing slash gracefully

v1.0.0-beta.5

1 March 2021

  • fix: changes throw an error (headers sent)
  • fix: project config
  • test: add codeql-analysis
  • chore: update dependencies

v1.0.0-beta.4

11 December 2020

  • perf: search for better performance
  • chore: update dependencies

v1.0.0-beta.3

5 December 2020

  • fix: example usage in readme

v1.0.0-beta.2

5 December 2020

  • feat: babel remove console from dist

v1.0.0-beta.1

5 December 2020

  • feat: transpile to commonjs before publishing the package
  • refactor: lib exports
  • docs: update readme
  • chore: script to transpile to commonjs before releasing

v1.0.0-beta.0

3 December 2020

  • feat: a functional next.js pouchdb router