Skip to content

Commit 19c2919

Browse files
committed
update jsdoc
1 parent 5dd3143 commit 19c2919

File tree

4 files changed

+1
-31
lines changed

4 files changed

+1
-31
lines changed

examples/post-start-secret-delivery/post-start-hook.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const fs = require('fs').promises;
44
/**
55
* This is a post-start hook that will be called after an app started.
66
* @param {object} info
7-
* @param {string} info.pid The apps PID
7+
* @param {number} info.pid The apps PID
88
* @param {Stream} info.stdin The apps STDIN stream
99
* @param {Stream} info.stdout The apps STDOUT stream
1010
* @param {Stream} info.stderr The apps STDERR stream
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
'use strict';
22

3-
/**
4-
* This is a post-start hook that will be called after an app started.
5-
* @param {object} info
6-
* @param {string} info.pid The apps PID
7-
* @param {object} info.stdin The apps STDIN stream
8-
* @param {object} info.stdout The apps STDOUT stream
9-
* @param {object} info.stderr The apps STDERR stream
10-
* @param {object} pm2_env The apps environment variables
11-
* @returns {void}
12-
*/
133
module.exports = function hook(info, cb) {
144
cb(new Error('error-from-post-start-hook-' + info.pid));
155
}

test/fixtures/post_start_hook/post_start_hook_normal.js

-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
'use strict';
22

3-
/**
4-
* This is a post-start hook that will be called after an app started.
5-
* @param {object} info
6-
* @param {string} info.pid The apps PID
7-
* @param {Stream} info.stdin The apps STDIN stream
8-
* @param {Stream} info.stdout The apps STDOUT stream
9-
* @param {Stream} info.stderr The apps STDERR stream
10-
* @param {object} pm2_env The apps environment variables
11-
* @returns {void}
12-
*/
133
module.exports = function hook(info, cb) {
144
console.log('hello-from-post-start-hook-' + info.pid);
155
info.pm2_env.post_start_hook_info = {
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
'use strict';
22

3-
/**
4-
* This is a post-start hook that will be called after an app started.
5-
* @param {object} info
6-
* @param {string} info.pid The apps PID
7-
* @param {object} info.stdin The apps STDIN stream
8-
* @param {object} info.stdout The apps STDOUT stream
9-
* @param {object} info.stderr The apps STDERR stream
10-
* @param {object} pm2_env The apps environment variables
11-
* @returns {void}
12-
*/
133
module.exports = function hook(info, cb) {
144
throw new Error('thrown-from-post-start-hook-' + info.pid);
155
}

0 commit comments

Comments
 (0)