Get the current file's read time (i.e. "How long to read")

[PuppyGirlBelly]

Hi, I have spent way too much time procrastinating working on this; so I figured I should try and share so somebody else doesn't have to spend this effort.

I like to have a part of my frontmatter to list how long a page is; as I use Obsidian to hold documents I want to read offline. So I created a template that should give an approximate estimate of how long a document is. It's not the most accurate as tp.file.content still includes frontmatter; but I have filtered out most non-readable characters so it should give a decent ballpark.

Version 1.0

• Gist of the script

  • Includes code that outputs in a 'human readable' format, for example;
    • 128 minutes reads as "2 hours and 8 minutes"
    • 60 minutes reads as "1 hour"
    • sub-1 minute reads as "Less than one minute"

• Inline Template

<%*
    const WPM = 255 
    const words = await tp.file.content.trim().replace(/[^\w\s]/g, "").split(/\s+/).filter((x) => x !== "");
    const readTime = Math.ceil(words.length / WPM);
%>
read time: <% readTime %> minutes

Let me know of any improvements I can make or any additions folks might need!

[Dercraker]

I made a small Upgrade. The template converts to Hours and Minutes if over 60 Minutes

<%*
const WPM = 255 
const words = await tp.file.content.trim().replace(/[^\w\s]/g, "").split(/\s+/).filter((x) => x !== "");
const readTime = Math.ceil(words.length / WPM);
const totalHours = (readTime / 60);
const readHours = Math.floor(totalHours);
const totalMinutes = (totalHours - readHours) * 60;
const readMinutes = Math.round(totalMinutes);

if (readHours != 0)
	tR += `${readHours} hour${readHours == 1 ? "": "s"} and `
tR += `${readMinutes} minute${readMinutes == 1 ? "": "s"}`
%>

[SupremeToaster]

That's super awesome! Thanks for sharing!

[FroguelYipit]

Is there a way to auto-update this every time I open the doc? Maybe if this is turned on a file property? Many documents get increased over time and this would be super useful.

[Gryn23]

This is so important. At the moment the template only spits out the number of minutes it takes to read the note when created. Which is typically 0 minutes, as you still need to write the content.

Anyone know a way to update this script when the file is updated?

[Zachatoo]

If you need it to dynamically update, I'd recommend using the Dataview plugin instead. Here's an example of a "how long to read" dynamic query I made a while ago.
#913 (comment)

[Gryn23]

Thanks a lot @Zachatoo !