cannery-adapter v1.0.0

Welcome to cannery-adapter

The base adapter for Cannery.

API

The Cannery Adapter is meant to be extended. There are just a handful of methods that can be overwritten to allow you to get and set data from whatever storage mechanism you like.

Adding an adapter to you model is as trivial as adding it as a static property to your model:

const Cannery = require('cannery');
const CanneryAdapter = require('cannery-adapter');

class User extends Cannery.Model {

    static adapter = CanneryAdapter;

    getFields () {
        return {
            // ...
        };
    }

}

module.exports = User;

Methods

Every Cannery adapter has the following methods:

create (:data)

Create a new instance of a model.

Returns a promise which resolves to an object with the newly saved data.

destroy (:id)

Destroy and instance of a model.

Returns a promise.

findAll (:query)

Find all instances of a Model and resolve an array.

Returns a promise which resolves to an array.

findOne (:id)

Find a single instance of a model by ID.

Returns a promise which resolves to an object.

getModel ()

Return the model instance. You should not need to overwrite this.

update (:id, :data)

Updates an instance of a model.

Return a promise which resolves to an object with the newly saved data.

Contributing

We encourage you to contribute to cannery-adapter by submitting bug reports and pull requests through Github.

License

cannery-adapter is released under The MIT License (MIT)

Copyright (c) 2015

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.