From cf7129e313ae2a8b9bc33cedcf006edf3a717587 Mon Sep 17 00:00:00 2001 From: harryadel Date: Sun, 2 Apr 2023 05:42:29 +0200 Subject: [PATCH] Document `main` function in webapp --- docs/source/packages/webapp.md | 1 + packages/webapp/webapp_server.js | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/docs/source/packages/webapp.md b/docs/source/packages/webapp.md index a829dd21a1..b20d8a6edf 100644 --- a/docs/source/packages/webapp.md +++ b/docs/source/packages/webapp.md @@ -160,3 +160,4 @@ WebApp.addUpdatedNotifyHook(({arch, manifest, runtimeConfig}) => { {% apibox "WebApp.addUpdatedNotifyHook" %} {% apibox "addUpdatedNotifyHookCallback(options)" %} +{% apibox "main" %} \ No newline at end of file diff --git a/packages/webapp/webapp_server.js b/packages/webapp/webapp_server.js index 1c659da0ad..d2599526e2 100644 --- a/packages/webapp/webapp_server.js +++ b/packages/webapp/webapp_server.js @@ -1360,6 +1360,13 @@ function runWebAppServer() { }, }); + /** + * @name main + * @locus Server + * @summary Starts the HTTP server. + * If `UNIX_SOCKET_PATH` is present Meteor's HTTP server will use that socket file for inter-process communication, instead of TCP. + * If you choose to not include webapp package in your application this method still must be defined for your Meteor application to work. + */ // Let the rest of the packages (and Meteor.startup hooks) insert connect // middlewares and update __meteor_runtime_config__, then keep going to set up // actually serving HTML.