This plugin will inject expect reading time and word count statistics into the page object.

Will automatically inject readingTime into the page object:

interface ReadingTime {
  /** Expect reading minute */
  minutes: number;
  /** Words count */
  words: number;
}

How to use

Install

Usage

Plugin Options

wordPerMinute

• Type: number
• Default: 300

Reading speed (words per minute)

locales

• Type: ReadingTimeLocaleConfig

  interface ReadingTimeLocaleData {
    /**
     * Word template, `$word` will be automatically replaced by actual words
     */
    word: string;
  
    /**
     * Text for less than one minute
     */
    less1Minute: string;
  
    /**
     * Time template
     */
    time: string;
  }
  
  interface ReadingTimeLocaleConfig {
    [localePath: string]: ReadingTimeLocaleData;
  }
  

• Required: No

Locales config for reading-time plugin.