Natty Precise Maverick

    tiny-tim

    0.0.4 • Public • Published

    Tiny Tim

    Meet Tim, a simple, small timer

    Made with ❤ at @outlandish

    npm version


    🍪 Comes in at 156 bytes minified. Zero dependencies.

    ✨ Tiny Tim is compiled using babili for ES6+ and CommonJS environments.

    👉 Use your preferred bundler and transpiler as required.

    Install

    npm install --save tiny-tim
    yarn add tiny-tim

    Import

    // ES2015
    import timer from 'tiny-tim'
    // CommonJS
    var timer = require('tiny-tim') 

    Usage

    timer([unit[, suffix]]) : Function

    Create a timer and start counting!

    • unit {String} Unit of time to return (optional, default="s")
    • suffix {Boolean} Attach suffix, e.g. unit "s" appends "s" (optional, default=false)

    Available units: "ms", "s", "m", "h"

    Returns a function that stops the timer and returns the duration:

    • as a string if with suffix
    • or as a number without

    Examples

    // Time in seconds with suffix
    const seconds = timer('s', true)
     
    setTimeout(() => {
      console.log(seconds()) //=> '10s'
    }, 10000)
     
    // reuse a timer...
     
    setTimeout(() => {
      console.log(seconds()) //=> '15s'
    }, 15000)
    // Time milliseconds without suffix
    const milliseconds = timer()
     
    setTimeout(() => {
      console.log(milliseconds()) //=> 1000
    }, 1000)

    Contributing

    All pull requests and issues welcome!

    If you're not sure how, check out the great video tutorials on egghead.io!

    Install

    npm i tiny-tim

    DownloadsWeekly Downloads

    226

    Version

    0.0.4

    License

    MIT

    Last publish

    Collaborators

    • sdgluck