joe/kami-parse-server
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds documentations for adapters and main constructors (#4951)

Browse Source 
* wip

* Adds documentations for adapters, and constructors

* nits

* nit
This commit is contained in:
Florent Vilmart
2018-08-10 15:51:31 -04:00
parent 0571675fcd
commit 942b9b5b1a
17 changed files with 3316 additions and 2708 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/cloud-code/Parse.Cloud.js
View File

@@ -227,7 +227,7 @@ ParseCloud.httpRequest = require("./httpRequest");
module.exports = ParseCloud;
/**
* @typedef Parse.Cloud.TriggerRequest
* @interface Parse.Cloud.TriggerRequest
* @property {String} installationId If set, the installationId triggering the request.
* @property {Boolean} master If true, means the master key was used.
* @property {Parse.User} user If set, the user that made the request.
@@ -240,7 +240,7 @@ module.exports = ParseCloud;
*/
/**
* @typedef Parse.Cloud.BeforeFindRequest
* @interface Parse.Cloud.BeforeFindRequest
* @property {String} installationId If set, the installationId triggering the request.
* @property {Boolean} master If true, means the master key was used.
* @property {Parse.User} user If set, the user that made the request.
@@ -253,7 +253,7 @@ module.exports = ParseCloud;
*/
/**
* @typedef Parse.Cloud.AfterFindRequest
* @interface Parse.Cloud.AfterFindRequest
* @property {String} installationId If set, the installationId triggering the request.
* @property {Boolean} master If true, means the master key was used.
* @property {Parse.User} user If set, the user that made the request.
@@ -266,7 +266,7 @@ module.exports = ParseCloud;
*/
/**
* @typedef Parse.Cloud.FunctionRequest
* @interface Parse.Cloud.FunctionRequest
* @property {String} installationId If set, the installationId triggering the request.
* @property {Boolean} master If true, means the master key was used.
* @property {Parse.User} user If set, the user that made the request.
@@ -274,7 +274,7 @@ module.exports = ParseCloud;
*/
/**
* @typedef Parse.Cloud.JobRequest
* @interface Parse.Cloud.JobRequest
* @property {Object} params The params passed to the background job.
* @property {function} message If message is called with a string argument, will update the current message to be stored in the job status.
*/