{
  "url": "https://unifast.dev/docs/packages/node/reading-time/",
  "locale": "en",
  "title": "readingTime()",
  "description": "Estimate the reading time of the document and include it in the compile result.",
  "section": "packages",
  "body": "```ts\nimport { readingTime } from \"@unifast/node\";\n```\n\n## Signature\n\n```ts\nfunction readingTime(options?: ReadingTimePluginOptions): UnifastPlugin\n```\n\n## Parameters\n\n### options?\n\nConfiguration for reading time estimation\n\n| Property | Type | Default | Description |\n|----------|------|---------|-------------|\n| `wordsPerMinute` | `number` | `200` | Words per minute for Latin text |\n| `cjkCharsPerMinute` | `number` | `500` | Characters per minute for CJK text |\n\n## Returns\n\nThe plugin adds a `readingTime` property to the compile result:\n\n| Property | Type | Description |\n|----------|------|-------------|\n| `result.readingTime.minutes` | `number` | Estimated reading time in minutes (minimum 1, rounded up to nearest 0.5) |\n| `result.readingTime.words` | `number` | Total word count (Latin words + CJK characters) |\n\n## Usage\n\n```ts\nimport { compile, readingTime } from \"@unifast/node\";\n\nconst md = `\n# My Article\n\nThis is a short article with some content that demonstrates\nreading time estimation.\n`;\n\nconst result = compile(md, {\n  plugins: [readingTime()],\n});\n\nconsole.log(result.readingTime);\n// { minutes: 1, words: 16 }\n```\n\n## Examples\n\n### Custom words per minute\n\n```ts\nimport { compile, readingTime } from \"@unifast/node\";\n\nconst md = `A long article with many words...`;\n\nconst result = compile(md, {\n  plugins: [\n    readingTime({\n      wordsPerMinute: 150, // slower reading speed\n    }),\n  ],\n});\n\nconsole.log(result.readingTime.minutes);\n```\n\n### CJK content\n\n```ts\nimport { compile, readingTime } from \"@unifast/node\";\n\nconst md = `\n# 日本語の記事\n\n今日は天気がとても良いです。公園で散歩をしました。\n`;\n\nconst result = compile(md, {\n  plugins: [\n    readingTime({\n      cjkCharsPerMinute: 400, // adjust for CJK reading speed\n    }),\n  ],\n});\n\nconsole.log(result.readingTime);\n// { minutes: 1, words: ... }\n```\n\n### Mixed Latin and CJK text\n\nReading time is calculated separately for Latin words and CJK characters, then combined. Code blocks are excluded from the word count.\n\n```ts\nimport { compile, readingTime } from \"@unifast/node\";\n\nconst md = `\n# Getting Started ガイド\n\nThis guide explains how to use the 設定ファイル for configuration.\n`;\n\nconst result = compile(md, {\n  plugins: [readingTime()],\n});\n\n// Latin words counted at 200 WPM, CJK characters at 500 CPM\nconsole.log(result.readingTime);\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/docs/packages/node/reading-time.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/reading-time.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/reading-time.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/reading-time.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/reading-time.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/reading-time.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/it/docs/packages/node/reading-time.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/es/docs/packages/node/reading-time.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/reading-time.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/de/docs/packages/node/reading-time.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/reading-time.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/reading-time.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/id/docs/packages/node/reading-time.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/reading-time.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/reading-time/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/reading-time.json"
    }
  ]
}