From 3fbb7b5310e2cfda617d35f8b326fb0b05dc252b Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Fri, 5 Dec 2014 15:33:24 -0400 Subject: [PATCH] Document resin/models/_canvas --- lib/resin/models/_canvas.coffee | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/lib/resin/models/_canvas.coffee b/lib/resin/models/_canvas.coffee index 5fc9b827..1e5712f0 100644 --- a/lib/resin/models/_canvas.coffee +++ b/lib/resin/models/_canvas.coffee @@ -1,11 +1,21 @@ _ = require('lodash') -Canvas = require('resin-platform-api') Promise = require('bluebird') +Canvas = require('resin-platform-api')(_, Promise) settings = require('../settings') server = require('../server/server') promisifiedServerRequest = Promise.promisify(server.request, server) -class CanvasRequestService extends Canvas(_, Promise) +class CanvasRequestService extends Canvas + + # Trigger a request to the resin.io API + # + # Makes use of [pinejs-client](https://bitbucket.org/rulemotion/pinejs-client-js) + # + # @private + # + # @param {Object} params request params (same as node-request params) + # + # @note You shouldn't make use of this method directly, but through models _request: (params) -> params.json = params.data params.gzip ?= true