tiny-tim
v0.0.4
Published
Meet Tim, a small, simple timer
Downloads
1,937
Maintainers
Readme
:cookie: Comes in at 156 bytes
minified. Zero dependencies.
:sparkles: Tiny Tim is compiled using babili
for ES6+ and CommonJS environments.
:point_right: 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!