Ghost/core/server/adapters/scheduling/index.js
kirrg001 8f76827464 Added comments for post scheduling
no issue

- jsdoc
- inline comments
2019-05-01 22:05:42 +02:00

24 lines
846 B
JavaScript

const postScheduling = require(__dirname + '/post-scheduling');
/**
* @description Initialise all scheduler modules.
*
* We currently only support post-scheduling: publish posts/pages when scheduled.
*
* @param {Object} options
* {
* schedulerUrl: [String] Remote scheduler domain.
* active: [String] Name of the custom scheduler.
* apiUrl: [String] Target Ghost API url.
* internalPath: [String] Folder path where to find the default scheduler.
* contentPath: [String] Folder path where to find custom schedulers.
* }
*
* @TODO: Simplify the passed in options.
*/
exports.init = function init(options) {
options = options || {};
return postScheduling.init(options);
};