1.0.2 • Published 8 years ago

loopback-likes-mixin v1.0.2

Weekly downloads
5
License
MIT
Repository
github
Last release
8 years ago

NPM NPM

Loopback Stats Mixin

This module is designed for the Strongloop Loopback framework. It provides likes and dislikes functionallity to any Model.

INSTALL

  npm install loopback-likes-mixin --save

MIXINSOURCES

With loopback-boot@v2.8.0 mixinSources have been implemented in a way which allows for loading this mixin without changes to the server.js file previously required.

Add the mixins property to your server/model-config.json like the following:

{
  "_meta": {
    "sources": [
      "loopback/common/models",
      "loopback/server/models",
      "../common/models",
      "./models"
    ],
    "mixins": [
      "loopback/common/mixins",
      "../node_modules/loopback-likes-mixin/dist",
      "../common/mixins"
    ]
  }
}

STATS MIXIN

This mixin creates a Remote Method with endpoint entry /:id/like.

EXAMPLE

The following is the default configuration

"mixins": {
    "Likes": [
        {
          "method": "like",
          "endpoint": "/:id/like",
          "likes": "likes",
          "userModel": "User"
        }
    ]
}

is equivalent to

"mixins": {
    "Likes": true
}

The code defined above would create a localhost:3000/api/model/:id/likes endpoint with the ability to like and dislike an instance of a Model in which the mixin is implemented.

BOOT OPTIONS

The following options are the optional configurations for the mixin to work.

OptionsTypeRequriedPossible ValuesExamples
methodStringNoAnylike, likeThis, liker
endpointStringNoURL Form/likes, /:id/likes
descriptionStringNoAnyLoopback Explorer Description
likesStringNoAnyModel property name with Object type
userModelStringNoUser based modelsUser, Account, Admin.. e

LICENSE

MTI