plexinc/papr

plexinc/papr

README

Papr


Papr

TypeScript-safe schemas
JSON Schema MongoDB validation
🎉* Lightweight library
🚀* Blazing fast

Github Actions

papr is a lightweight library built around the MongoDB NodeJS driver, written in TypeScript.

papr uses MongoDB's JSON Schema validation feature to enable validation of document writes at runtime (requires MongoDB 3.6+).

papr has a familiar API - if you have used the raw mongodb methods to query and change documents before, then you already know how to use papr.

Sample code


  1. ``` ts
  2. import Papr, { schema, types } from 'papr';

  4. const papr = new Papr();

  6. const User = papr.model('users', schema({
  7.   age: types.number(),
  8.   firstName: types.string({ required: true }),
  9.   lastName: types.string({ required: true }),
  10. }));

  12. const johnWick = await User.find({ firstName: 'John', lastName: 'Wick' });
  13. ```

Documentation


Read the documentation at: plexinc.github.io/papr

Contributing


This repository is following the Conventional Commits standard.

License


MIT

Inspiration


Mongoose
ts-mongoose