Ghost/core/frontend/helpers/reading_time.js
Hannah Wolfe c902d91c81
Renamed rendering service to handlebars
- This fits more closely, as this service is to so with rendering helpers and small parts
- Whereas we want to use "rendering" for things concerned with rendering pages
2022-04-05 20:10:33 +01:00

31 lines
1004 B
JavaScript

// # Reading Time Helper
//
// Usage: `{{reading_time}}`
// or for translatable themes, with (t) translation helper's subexpressions:
// `{{reading_time seconds=(t "< 1 min read") minute=(t "1 min read") minutes=(t "% min read")}}`
// and in the theme translation file, for example Spanish es.json:
// "< 1 min read": "< 1 min de lectura",
// "1 min read": "1 min de lectura",
// "% min read": "% min de lectura",
//
// Returns estimated reading time for post
const {checks} = require('../services/data');
const {SafeString} = require('../services/handlebars');
const {readingTime: calculateReadingTime} = require('@tryghost/helpers');
module.exports = function reading_time(options) {// eslint-disable-line camelcase
options = options || {};
options.hash = options.hash || {};
// only calculate reading time for posts
if (!checks.isPost(this)) {
return null;
}
let readingTime = calculateReadingTime(this, options.hash);
return new SafeString(readingTime);
};