mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-17 23:44:39 -05:00
Cleaned up loader method docs
refs https://linear.app/tryghost/issue/CORE-35/refactor-route-and-redirect-settings - There were duplicate descriptions of the same thing in multiple places. Made the description a bit more accurate given the latest changes
This commit is contained in:
parent
ebc33180a1
commit
85f18850a9
2 changed files with 3 additions and 9 deletions
|
@ -57,10 +57,10 @@ const loadSettings = async () => {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reads the desired settings YAML file and passes the
|
* Reads the routes.yaml settings file and passes the
|
||||||
* file to the YAML parser which then returns a JSON object.
|
* file to the YAML parser which then returns a JSON object.
|
||||||
* NOTE: loading happens synchronously
|
*
|
||||||
* @returns {Object} settingsFile
|
* @returns {Object} settingsFile in following format: {routes: {}, collections: {}, resources: {}}
|
||||||
*/
|
*/
|
||||||
module.exports.loadSettingsSync = function loadSettingsSync() {
|
module.exports.loadSettingsSync = function loadSettingsSync() {
|
||||||
const setting = 'routes';
|
const setting = 'routes';
|
||||||
|
|
|
@ -145,12 +145,6 @@ const init = function () {
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports.init = init;
|
module.exports.init = init;
|
||||||
/**
|
|
||||||
* Fetches routes YAML settings synchronously.
|
|
||||||
* will return a JSON Object like this:
|
|
||||||
* {routes: {}, collections: {}, resources: {}}
|
|
||||||
* @returns {Object} routes.yaml in JSON format
|
|
||||||
*/
|
|
||||||
module.exports.loadRouteSettingsSync = SettingsLoader.loadSettingsSync;
|
module.exports.loadRouteSettingsSync = SettingsLoader.loadSettingsSync;
|
||||||
|
|
||||||
module.exports.api = {
|
module.exports.api = {
|
||||||
|
|
Loading…
Add table
Reference in a new issue