maz-ui/dist/composables/useReadingTime.d.ts

A standalone components library for Vue.Js 3 & Nuxt.Js 3

import { ComputedRef, Ref } from 'vue';
export interface ReadingTimeOptions {
    /** Content to calculate the reading time */
    content?: string | Ref<string>;
    /** Selector of the content to calculate the reading time */
    contentSelector?: string | Ref<string>;
    /** Ref of the content to calculate the reading time */
    contentRef?: Ref<HTMLElement | undefined>;
    /**
     * Words per minute
     * @default 150
     */
    velocity?: number | Ref<number>;
}
export interface ReadingTimeReturn {
    /** Content to calculate the reading time */
    content: ComputedRef<string | undefined | null>;
    /** Number of words in the content */
    wordCount: ComputedRef<number>;
    /** Words per minute */
    velocity: ComputedRef<number>;
    /** Reading time in minutes */
    duration: ComputedRef<number>;
}
export declare function useReadingTime(options: ReadingTimeOptions): ReadingTimeReturn;