Skip to content

Commit 8867ca3

Browse files
Ace Nassrijmdobry
authored andcommitted
Document 'callback' parameter name in @param (GoogleCloudPlatform#417)
1 parent fd403fe commit 8867ca3

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

functions/helloworld/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ require('@google-cloud/debug-agent').start();
2626
* Cloud Function.
2727
*
2828
* @param {object} event The Cloud Functions event.
29-
* @param {function} The callback function.
29+
* @param {function} callback The callback function.
3030
*/
3131
exports.helloWorld = function helloWorld (event, callback) {
3232
console.log(`My Cloud Function: ${event.data.message}`);
@@ -63,7 +63,7 @@ exports.helloHttp = function helloHttp (req, res) {
6363
* Background Cloud Function.
6464
*
6565
* @param {object} event The Cloud Functions event.
66-
* @param {function} The callback function.
66+
* @param {function} callback The callback function.
6767
*/
6868
exports.helloBackground = function helloBackground (event, callback) {
6969
callback(null, `Hello ${event.data.name || 'World'}!`);
@@ -75,7 +75,7 @@ exports.helloBackground = function helloBackground (event, callback) {
7575
* Background Cloud Function to be triggered by Pub/Sub.
7676
*
7777
* @param {object} event The Cloud Functions event.
78-
* @param {function} The callback function.
78+
* @param {function} callback The callback function.
7979
*/
8080
exports.helloPubSub = function (event, callback) {
8181
const pubsubMessage = event.data;
@@ -92,7 +92,7 @@ exports.helloPubSub = function (event, callback) {
9292
* Background Cloud Function to be triggered by Cloud Storage.
9393
*
9494
* @param {object} event The Cloud Functions event.
95-
* @param {function} The callback function.
95+
* @param {function} callback The callback function.
9696
*/
9797
exports.helloGCS = function (event, callback) {
9898
const file = event.data;
@@ -116,7 +116,7 @@ exports.helloGCS = function (event, callback) {
116116
* Background Cloud Function that throws an error.
117117
*
118118
* @param {object} event The Cloud Functions event.
119-
* @param {function} The callback function.
119+
* @param {function} callback The callback function.
120120
*/
121121
exports.helloError = function helloError (event, callback) {
122122
// This WILL be reported to Stackdriver errors
@@ -130,7 +130,7 @@ exports.helloError = function helloError (event, callback) {
130130
* Background Cloud Function that throws a value.
131131
*
132132
* @param {object} event The Cloud Functions event.
133-
* @param {function} The callback function.
133+
* @param {function} callback The callback function.
134134
*/
135135
exports.helloError2 = function helloError2 (event, callback) {
136136
// This will NOT be reported to Stackdriver errors
@@ -143,7 +143,7 @@ exports.helloError2 = function helloError2 (event, callback) {
143143
* Background Cloud Function that throws an error.
144144
*
145145
* @param {object} event The Cloud Functions event.
146-
* @param {function} The callback function.
146+
* @param {function} callback The callback function.
147147
*/
148148
exports.helloError3 = function helloError3 (event, callback) {
149149
// This will NOT be reported to Stackdriver errors

0 commit comments

Comments
 (0)