readingTime()

import { readingTime } from "@unifast/node";

Chữ ký

function readingTime(options?: ReadingTimePluginOptions): UnifastPlugin

Tham số

options?

Cấu hình cho việc ước lượng thời gian đọc

Giá trị trả về

Plugin bổ sung thuộc tính readingTime vào kết quả biên dịch:

Cách dùng

import { compile, readingTime } from "@unifast/node";

const md = `
# My Article

This is a short article with some content that demonstrates
reading time estimation.
`;

const result = compile(md, {
  plugins: [readingTime()],
});

console.log(result.readingTime);
// { minutes: 1, words: 16 }

Ví dụ

Tùy chỉnh số từ mỗi phút

import { compile, readingTime } from "@unifast/node";

const md = `A long article with many words...`;

const result = compile(md, {
  plugins: [
    readingTime({
      wordsPerMinute: 150, // slower reading speed
    }),
  ],
});

console.log(result.readingTime.minutes);

Nội dung CJK

import { compile, readingTime } from "@unifast/node";

const md = `
# 日本語の記事

今日は天気がとても良いです。公園で散歩をしました。
`;

const result = compile(md, {
  plugins: [
    readingTime({
      cjkCharsPerMinute: 400, // adjust for CJK reading speed
    }),
  ],
});

console.log(result.readingTime);
// { minutes: 1, words: ... }

Văn bản hỗn hợp Latin và CJK

Thời gian đọc được tính riêng biệt cho từ Latin và ký tự CJK, sau đó kết hợp lại. Các khối mã được loại khỏi số từ đếm.

import { compile, readingTime } from "@unifast/node";

const md = `
# Getting Started ガイド

This guide explains how to use the 設定ファイル for configuration.
`;

const result = compile(md, {
  plugins: [readingTime()],
});

// Latin words counted at 200 WPM, CJK characters at 500 CPM
console.log(result.readingTime);