readingTime()

Memperkirakan waktu baca dokumen dan menyertakannya pada hasil compile.

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

Signature

function readingTime(options?: ReadingTimePluginOptions): UnifastPlugin

Parameter

options?

Konfigurasi untuk estimasi waktu baca

PropertiTipeDefaultDeskripsi
wordsPerMinutenumber200Kata per menit untuk teks Latin
cjkCharsPerMinutenumber500Karakter per menit untuk teks CJK

Return

Plugin menambahkan properti readingTime ke hasil compile:

PropertiTipeDeskripsi
result.readingTime.minutesnumberEstimasi waktu baca dalam menit (minimum 1, dibulatkan ke atas ke kelipatan 0.5 terdekat)
result.readingTime.wordsnumberTotal jumlah kata (kata Latin + karakter CJK)

Penggunaan

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 }

Contoh

Kata per menit kustom

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);

Konten 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: ... }

Teks campuran Latin dan CJK

Waktu baca dihitung secara terpisah untuk kata Latin dan karakter CJK, kemudian digabungkan. Code block dikecualikan dari hitungan kata.

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);