Skip to content

docs: add param tags for mixin methods #2449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephenplusplus merged 2 commits into from
Jul 17, 2017
Merged

docs: add param tags for mixin methods #2449

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c526c8f
docs: add param tags for mixin methods
callmehiphop Jul 12, 2017
52a09d4
remove @throws
callmehiphop Jul 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/datastore/src/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,16 @@ DatastoreRequest.prototype.get = function(keys, options, callback) {

/**
* Maps to {module:datastore#save}, forcing the method to be `insert`.
*
* @param {object|object[]} entities - Datastore key object(s).
* @param {Key} entities.key - Datastore key object.
* @param {object|object[]} entities.data - Data to save with the provided key.
* If you provide an array of objects, you must use the explicit syntax:
* `name` for the name of the property and `value` for its value. You may
* also specify an `excludeFromIndexes` property, set to `true` or `false`.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.apiResponse - The full API response.
*/
DatastoreRequest.prototype.insert = function(entities, callback) {
entities = arrify(entities)
Expand Down Expand Up @@ -990,6 +1000,16 @@ DatastoreRequest.prototype.save = function(entities, callback) {

/**
* Maps to {module:datastore#save}, forcing the method to be `update`.
*
* @param {object|object[]} entities - Datastore key object(s).
* @param {Key} entities.key - Datastore key object.
* @param {object|object[]} entities.data - Data to save with the provided key.
* If you provide an array of objects, you must use the explicit syntax:
* `name` for the name of the property and `value` for its value. You may
* also specify an `excludeFromIndexes` property, set to `true` or `false`.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.apiResponse - The full API response.
*/
DatastoreRequest.prototype.update = function(entities, callback) {
entities = arrify(entities)
Expand All @@ -1001,6 +1021,16 @@ DatastoreRequest.prototype.update = function(entities, callback) {

/**
* Maps to {module:datastore#save}, forcing the method to be `upsert`.
*
* @param {object|object[]} entities - Datastore key object(s).
* @param {Key} entities.key - Datastore key object.
* @param {object|object[]} entities.data - Data to save with the provided key.
* If you provide an array of objects, you must use the explicit syntax:
* `name` for the name of the property and `value` for its value. You may
* also specify an `excludeFromIndexes` property, set to `true` or `false`.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.apiResponse - The full API response.
*/
DatastoreRequest.prototype.upsert = function(entities, callback) {
entities = arrify(entities)
Expand Down