From 2f1b0578771cb036e0cd3a83bcbdcec63c2135d8 Mon Sep 17 00:00:00 2001 From: Daniel Date: Wed, 1 Nov 2023 16:19:06 +0100 Subject: [PATCH] update jsdoc --- examples/post-start-secret-delivery/post-start-hook.js | 2 +- .../fixtures/post_start_hook/post_start_hook_errors.js | 10 ---------- .../fixtures/post_start_hook/post_start_hook_normal.js | 10 ---------- .../fixtures/post_start_hook/post_start_hook_throws.js | 10 ---------- 4 files changed, 1 insertion(+), 31 deletions(-) diff --git a/examples/post-start-secret-delivery/post-start-hook.js b/examples/post-start-secret-delivery/post-start-hook.js index 44c9591f8..eab638471 100644 --- a/examples/post-start-secret-delivery/post-start-hook.js +++ b/examples/post-start-secret-delivery/post-start-hook.js @@ -4,7 +4,7 @@ const fs = require('fs').promises; /** * This is a post-start hook that will be called after an app started. * @param {object} info - * @param {string} info.pid The apps PID + * @param {number} info.pid The apps PID * @param {Stream} info.stdin The apps STDIN stream * @param {Stream} info.stdout The apps STDOUT stream * @param {Stream} info.stderr The apps STDERR stream diff --git a/test/fixtures/post_start_hook/post_start_hook_errors.js b/test/fixtures/post_start_hook/post_start_hook_errors.js index 6430916dc..abe991756 100644 --- a/test/fixtures/post_start_hook/post_start_hook_errors.js +++ b/test/fixtures/post_start_hook/post_start_hook_errors.js @@ -1,15 +1,5 @@ 'use strict'; -/** - * This is a post-start hook that will be called after an app started. - * @param {object} info - * @param {string} info.pid The apps PID - * @param {object} info.stdin The apps STDIN stream - * @param {object} info.stdout The apps STDOUT stream - * @param {object} info.stderr The apps STDERR stream - * @param {object} pm2_env The apps environment variables - * @returns {void} - */ module.exports = function hook(info, cb) { cb(new Error('error-from-post-start-hook-' + info.pid)); } diff --git a/test/fixtures/post_start_hook/post_start_hook_normal.js b/test/fixtures/post_start_hook/post_start_hook_normal.js index 9e039f7ab..655a910cc 100644 --- a/test/fixtures/post_start_hook/post_start_hook_normal.js +++ b/test/fixtures/post_start_hook/post_start_hook_normal.js @@ -1,15 +1,5 @@ 'use strict'; -/** - * This is a post-start hook that will be called after an app started. - * @param {object} info - * @param {string} info.pid The apps PID - * @param {Stream} info.stdin The apps STDIN stream - * @param {Stream} info.stdout The apps STDOUT stream - * @param {Stream} info.stderr The apps STDERR stream - * @param {object} pm2_env The apps environment variables - * @returns {void} - */ module.exports = function hook(info, cb) { console.log('hello-from-post-start-hook-' + info.pid); info.pm2_env.post_start_hook_info = { diff --git a/test/fixtures/post_start_hook/post_start_hook_throws.js b/test/fixtures/post_start_hook/post_start_hook_throws.js index 448fec108..d17c9e068 100644 --- a/test/fixtures/post_start_hook/post_start_hook_throws.js +++ b/test/fixtures/post_start_hook/post_start_hook_throws.js @@ -1,15 +1,5 @@ 'use strict'; -/** - * This is a post-start hook that will be called after an app started. - * @param {object} info - * @param {string} info.pid The apps PID - * @param {object} info.stdin The apps STDIN stream - * @param {object} info.stdout The apps STDOUT stream - * @param {object} info.stderr The apps STDERR stream - * @param {object} pm2_env The apps environment variables - * @returns {void} - */ module.exports = function hook(info, cb) { throw new Error('thrown-from-post-start-hook-' + info.pid); }