PouchDB ORM written in pure Typescript
adamant: too hard to cut, break, or pierce.
- Define your entities and design docs with annotations
- design docs
- validate_doc_update (with PouchDB-Plugin or CouchDB)
$ yarn add @neoskop/adamant$ npm i @neoskop/adamant
Write you entities/interfaces at once
An entity requires an Entity and an Id annotation.
Create/update/read from database
declare ;;;await repo.createperson; // persist in databaseperson.name = 'Jane Doe';await repo.updateperson; // update database entryawait repo.upsertperson; // inserts/updates if needed; // personCopy equals personawait repo.deletepersonCopy; // marks database entry as deleted (_deleted = true)
Create and resolve relations
;;;;await personRepo.bulk.create; // persist multiple entities at once;await classRepo.createcls; // relations will be replace with their id's
$ yarn test$ yarn run coverage
$ yarn build
Copyright (c) 2018 Neoskop GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.