{
  "url": "https://unifast.dev/zh-CN/docs/packages/node/reading-time/",
  "locale": "zh-CN",
  "title": "readingTime()",
  "description": "估算文档的阅读时长，并将其附加到编译结果中。",
  "section": "packages",
  "body": "```ts\nimport { readingTime } from \"@unifast/node\";\n```\n\n## 签名\n\n```ts\nfunction readingTime(options?: ReadingTimePluginOptions): UnifastPlugin\n```\n\n## 参数\n\n### options?\n\n阅读时长估算的配置\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `wordsPerMinute` | `number` | `200` | 拉丁文的每分钟阅读词数 |\n| `cjkCharsPerMinute` | `number` | `500` | CJK 文本的每分钟阅读字符数 |\n\n## 返回值\n\n该插件会在编译结果中添加 `readingTime` 属性：\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `result.readingTime.minutes` | `number` | 估算的阅读时长（分钟，最小值为 1，向上取整到最接近的 0.5） |\n| `result.readingTime.words` | `number` | 总字数（拉丁词数 + CJK 字符数） |\n\n## 用法\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## 示例\n\n### 自定义每分钟词数\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 内容\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### 拉丁文与 CJK 混合文本\n\n阅读时长会分别按照拉丁词数和 CJK 字符数进行计算，然后合并得到最终结果。代码块不会计入字数。\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"
    }
  ]
}