@naturalcycles/js-lib/dist/string/readingTime.d.ts

Standard library for universal (browser + Node.js) javascript

import type { Integer } from '../types.js';
export interface ReadingTimeOptions {
    /**
     * A function that returns a boolean value depending on if a character is considered as a word bound.
     * Default: spaces, new lines and tabs
     */
    wordBound?: (char: string) => boolean;
    /**
     * Default 200
     */
    wordsPerMinute?: number;
}
export interface ReadingTimeStats {
    /**
     * Number of milliseconds.
     */
    time: Integer;
    minutes: Integer;
}
export interface WordCountStats {
    total: number;
}
export interface ReadingTimeResult extends ReadingTimeStats {
    words: WordCountStats;
}
/**
 * API: https://github.com/ngryman/reading-time
 */
export declare function readingTime(text: string, options?: ReadingTimeOptions): ReadingTimeResult;