pouch-odm v0.12.2

Pouch ODM

🚧 This library is in construction. More is coming soon!

🙃

What's coming

pouch-odm is a document mapper for pouchdb with full TypeScript support. It lets you use rich, type-safe models on top of pouchdb.

Here's a preview of the API as it currently stands:

import { pouchOdm } from 'pouch-odm';
import PouchDB from 'pouchdb';
import Memory from 'pouchdb-adapter-memory';
PouchDB.plugin(Memory);

const db = new PouchDB('test', { adapter: 'memory' });
const { defineModel } = pouchOdm(db);

interface IUser {
  email: string;
  name: string;
}

const User = defineModel<IUser>('user', {});

// create or update users
await User.upsert({ email: 'jdoe@email.com', name: 'John Doe' });

// find by id
await User.findById(id);

// find all users who have the name "John Doe"
await User.findAll({ name: 'John Doe' });

// remove user from database
await User.remove(user);