Como implementar "Tempo de leitura" usando JavaScript!

allbertuu commented 11 months ago

Você já se perguntou quanto tempo levaria para ler um artigo antes mesmo de começar a lê-lo? Bem, a biblioteca JavaScript reading-time pode facilitar essa estimativa para você. Essa biblioteca é focada em desempenho e simplicidade, oferecendo uma previsão do tempo de leitura com base no texto fornecido, que pode ser em formato de texto simples, markdown ou HTML.

Isso pra mim é mágica 🧙🏻‍♂️✨

Ah! Se você quiser ver isso em ação, basta olhar o cabeçalho desse post! A mais nova feature do blog foi feita em 5 minutos com essa biblioteca! ⏱🔥

Instalação 🔽

Para começar a utilizar o reading-time, você pode instalá-lo através do npm com o seguinte comando:

npm install reading-time

Uso 👨🏽‍💻

A utilização básica da biblioteca envolve o seguinte código:

Ah! O legal é que essa lib tem types, ou seja, declarações de tipos em TypeScript. Show, né? ❤

import readingTime from 'reading-time';

const stats = readingTime(text);

// Exemplo de saída:
// stats: {
//   text: '1 min read',
//   minutes: 1, 
//   time: 60000, // em milissegundos
//   words: 200
// }

Quanta informação daoraaaaa 😍

Personalização 🎨

A função readingTime aceita o texto a ser analisado e opcionalmente um objeto de opções, permitindo personalizar a estimativa. Sendo readingTime(text, options?).

Alguns parâmetros de opção incluem:

options.wordsPerMinute: Define a quantidade de palavras por minuto que um leitor médio pode ler (padrão: 200).
options.wordBound: Uma função opcional que retorna um valor booleano indicando se um caractere é considerado um delimitador de palavra (padrão: espaços, novas linhas e tabulações). -> Eu recomendo não mexer nisso rsrs.