ember-easy-orm

  • API Docs for Version: 1.0.0

    • Show:

    model

    Module: model
    Parent Module: mixins

    mixin in ORM model

    Table of Contents

    Methods

    _filterParams
    (
    • params
    )
    private

    Defined in addon/mixins/model.js:348

    filter request params

    Parameters:

    Returns:

    Object filtered params

    createRecord
    (
    • init
    )

    Defined in addon/mixins/model.js:242

    create new model with init options and model property

    Parameters:

    Returns:

    Object current model

    deleteRecord
    (
    • model
    • data
    )

    Defined in addon/mixins/model.js:265

    delete the record from backend

    Parameters:

    • model Object
    • data Object

      passed to backend server as extra params

    Returns:

    Promise

    deleteSerializer
    (
    • data
    )

    Defined in addon/mixins/model.js:456

    serializer for delete

    Parameters:

    • data Object

      response data from backend

    Returns:

    serializer data

    find
    (
    • params
    )

    Defined in addon/mixins/model.js:295

    find the records from backend according to params

    Parameters:

    Returns:

    Promise

    findOne
    (
    • id
    • data
    )

    Defined in addon/mixins/model.js:322

    find only one according to primary id

    Parameters:

    • id String

      primary key

    • data Object

      query parameter append to url

    Returns:

    Promise

    findOneSerializer
    (
    • data
    )

    Defined in addon/mixins/model.js:415

    serializer for findOne method

    Parameters:

    • data Object

      response data from backend

    Returns:

    serializer data

    findSerializer
    (
    • data
    )

    Defined in addon/mixins/model.js:366

    find serializer

    Parameters:

    • data Object

      response data from backend

    Returns:

    serializer data

    save
    (
    • model
    )
    Promise

    Defined in addon/mixins/model.js:174

    save the record to backend when create or update object

    Parameters:

    • model Object

      model needed to save

    Returns:

    Promise
    saveSerializer
    (
    • data
    )

    Defined in addon/mixins/model.js:447

    serializer for save method

    Parameters:

    • data Object

      response data from backend

    Returns:

    serializer data

    urlForDelete
    (
    • id
    )

    Defined in addon/mixins/model.js:155

    url for delete method request, use this method to custome delete url

    Parameters:

    • id Object

      object primary key

    Returns:

    String

    urlForFind ()

    Defined in addon/mixins/model.js:125

    url for find method request, use this method to custome find url

    Returns:

    String

    urlForFindOne ()

    Defined in addon/mixins/model.js:135

    url for findOne method request, use this method to custome findOne url

    Returns:

    String

    urlForSave
    (
    • id
    )

    Defined in addon/mixins/model.js:144

    url for save method request, use this method to custome create and update url

    Parameters:

    • id Object

      object primary key

    Returns:

    String

    Properties

    api

    String

    Defined in addon/mixins/model.js:165

    make api with host, namespace, url

    displayModel

    Object

    Defined in addon/mixins/model.js:118

    The object is for extract response data {user: [], comment:[], avatar: {}}

    Default: null

    host

    String

    Defined in addon/mixins/model.js:83

    The api host, default is current host

    Default: ""

    namespace

    String

    Defined in addon/mixins/model.js:90

    The api namespace like /v1 /v2

    Default: ""

    primaryKey

    String

    Defined in addon/mixins/model.js:111

    The model object primary key

    Default: "_id"

    rootKey

    String

    Defined in addon/mixins/model.js:97

    The response data business logic root key like: {'code': 0, 'resp':{'user':[]}, 'msg':''}, the resp is is the rootKey

    Default: ""

    url

    String

    Defined in addon/mixins/model.js:104

    The api url. If rootURL ends with slash , the url should not starts with slash

    Default: ""