Giter VIP home page Giter VIP logo

kr-persistence-mongoose's Introduction

kr-persistence-mongoose

Build Status Coverage Status

koa-rester module for adding Mongo persistence using mongoose.

Persistence

Kind: global class

new Persistence(model)

Create a KoaResterPersistence

Param Type Description
model Object The mongoose model

persistence.list(id) ⇒ Promise

If id is provided, it tries to get the element with the given id. It will throw an error if no element is found. If no id is provided lists all the stored items.

Kind: instance method of Persistence
Returns: Promise - Resolved with the object or the array of objects or rejected with an error.
Async:

Param Type
id String

persistence.create(data) ⇒ Promise

Creates a new object with the given data.

Kind: instance method of Persistence
Returns: Promise - Resolved with the new object or rejected with an error.

Param Type
data Object

persistence.update(id, data) ⇒ Promise

Updates an existing object with the given data.

Kind: instance method of Persistence
Returns: Promise - Resolved with the old object or rejected with an error.

Param Type Description
id Number The object id
data Object The fields to be updated

persistence.replace(id, data) ⇒ Promise

Replaces an existing object by a new one created with the given data.

Kind: instance method of Persistence
Returns: Promise - Resolved with the old object or rejected with an error.

Param Type Description
id Number The id of the object to be replaced
data Object The new object data

persistence.delete(id) ⇒ Promise

Deletes an existing object.

Kind: instance method of Persistence
Returns: Promise - Resolved with the removed object or rejected with an error.

Param Type Description
id Number The id of the object to be deleted

kr-persistence-mongoose's People

Contributors

dicearr avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.