TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-23 19:02:29 +03:00
Code Issues Projects Releases Wiki Activity

Added more precise JSDoc to email content generator

Browse Source 
refs https://github.com/TryGhost/Toolbox/issues/292

- Provided better type checking/suggestions
This commit is contained in:
Naz 2022-05-05 12:17:03 +08:00
parent 30f8b0a446
commit 32e42ae276
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ghost/email-content-generator/lib/email-content-generator.js
View File

@ -24,7 +24,7 @@ class EmailContentGenerator {
* @param {Object} options * @param {Object} options
* @param {string} options.template - HTML template name to use for generation * @param {string} options.template - HTML template name to use for generation
* @param {Object} [options.data] - variable data to use during HTML template compilation * @param {Object} [options.data] - variable data to use during HTML template compilation
* @returns {Promise} resolves with an object containing html and text properties * @returns {Promise<{html: String, text: String}>} resolves with an object containing html and text properties
*/ */
async getContent(options) { async getContent(options) {
const defaults = { const defaults = {