Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-01 02:41:39 -05:00
Code Issues Activity

Added JSDocs to bootstrap's init method

Browse source 
refs https://linear.app/tryghost/issue/CORE-103/decouple-internal-frontend-code-from-url-module

- Little type check and docs never hurt nobody
This commit is contained in:
Naz 2021-10-13 18:26:47 +02:00 • committed by naz
parent fead0e3dcf
commit 715da3e01f
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/frontend/services/routing/bootstrap.js vendored
View file

@ -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}) => {