My helper collections
Register an event listener, by default event will attatched to window object.
import { useEvent } from 'js-helpers'
useEvent({
event: 'load',
handler() {
// do some thing
}
})Register an event listener for document or DOMElement.
import { useEvent } from 'js-helpers'
useEvent({
event: 'load',
handler() {
// do something
}
}, document)
// or
const button = document.getElementById('btn')
useEvent({
event: 'onclick',
handler() {
// do something
}
}, button)useEvent returns a function that stops firing the callback:
import { useEvent } from 'js-helpers'
// Register an event listener
const event = useEvent({
event: 'load',
handler() {
// do something
}
}, document)
// stop firing the callback
event()Repeatedly calls a function or executes a code snippet, with a fixed time delay between each call.
import { useInterval } from 'js-helpers'
// execute callback every 3s
useInterval(function() {
// do something
}, 3000)useInterval returns a function that stops firing the callback:
import { useInterval } from 'js-helpers'
// execute callback every 3s
const poll = useInterval(function() {
// do something
}, 3000)
// stop firing the callback
poll()Sets a timer which executes a function or specified piece of code once the timer expires.
import { useTimeout } from 'js-helpers'
useTimeout(function() {
// do something
}, 3000)useTimeout returns a function that stops firing the callback:
import { useTimeout } from 'js-helpers'
// execute callback every 3s
const timer = useTimeout(function() {
// do something
}, 3000)
// stop firing the callback
timer()Perform no operation.
Why whould you need to use this? Here an example:
import { noop } from 'js-helpers'
export let warn = noop
if (process.env.NODE_ENV !== 'production') {
warn = (msg) => {
console.error(`[QuickProp warn]: ${msg}`)
}
}Now when you call warn function, it only show log output during development. This mean that in production, the warn function will not be overwritten.
Invokes interceptor with the object, and then returns object.
import { tap } from 'js-helpers'
const value = {}
const newValue = tap(value, function(payload) {
// do something with the payload
})Apply the callback if the given "value" is true.
import { when } from 'js-helpers'
const value = {}
when(value, function(payload) {
// do something with the payload
return payload
})
// you can provide a third callback to be execute if value if falsy
when(value, function(payload) {
// do something with the payload
return payload
}, function(payload) {
// Execute when value is falsy
// do something with the payload
return payload
})Async Sleep Function
Note: please use
sleepis asynchronous
import { sleep } from 'js-helpers'
async function doSomething() {
// Sleep for 3s
await sleep(3000)
// Then do something
}
doSomething()License under MIT