Northern Pileated Marmoset

    calculate-readtime
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.3 • Public • Published

    Read Time Calculator

    Customizable, easy-to-use, zero-dependency read time calculator.

    Typedefinitions are built-in

    build supportServer totalDownloads weeklyDownloads version stars license

    🐮 Installation

    • Using NPM: npm install calculate-readtime --save
    • Using Yarn: yarn add calculate-readtime

    🧶 Usage

    // Simple usage
    const { calculate } = require("calculate-readtime");
    
    const myText = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
    
    calculate(myText); // => returns "less than a minute"
    
    /* -------------------------------------------------------------------- */
    
    // Advanced usage
    const { calculate } = require("calculate-readtime");
    
    const myText = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
    const options = {
    	singular: "dakika",
    	plural: "dakika",
    	lessThanOne: "bir dakikadan kısa",
    	wpm: 200,
    };
    
    calculate(myText, options); // => returns "bir dakikadan kısa"

    🎈 Options

    Name Type Required Default
    wpm Number 200
    lessThanOne String less than a minute
    singular String minute
    plural String minutes

    🧦 Contributing

    Feel free to use GitHub's features.

    Keywords

    none

    Install

    npm i calculate-readtime

    DownloadsWeekly Downloads

    5

    Version

    0.0.3

    License

    GPL-3.0

    Unpacked Size

    66.8 kB

    Total Files

    8

    Last publish

    Collaborators

    • leydihavuc
    • ben_baris