From 715da3e01f152b25129752fd62ea6866a5bd00a1 Mon Sep 17 00:00:00 2001 From: Naz Date: Wed, 13 Oct 2021 18:26:47 +0200 Subject: [PATCH] Added JSDocs to bootstrap's init method refs https://linear.app/tryghost/issue/CORE-103/decouple-internal-frontend-code-from-url-module - Little type check and docs never hurt nobody --- core/frontend/services/routing/bootstrap.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/core/frontend/services/routing/bootstrap.js b/core/frontend/services/routing/bootstrap.js index 79f482ac1f..84e1093567 100644 --- a/core/frontend/services/routing/bootstrap.js +++ b/core/frontend/services/routing/bootstrap.js @@ -28,6 +28,10 @@ let _urlService; * - if you change your route settings, we will re-initialise routing * * @param {Object} options + * @param {Boolean} [options.start] - flag controlling if the frontend Routes should be reinitialized + * @param {String} options.apiVersion - API version frontend Routes should communicate through + * @param {Object} options.routerSettings - JSON configuration to build frontend Routes + * @param {Object} options.urlService - service providing resouce URL utility functions such as owns, getUrlByResourceId, and getResourceById * @returns {ExpressRouter} */ const init = ({start = false, routerSettings, apiVersion, urlService}) => {