thunky
Advanced tools
Package description
The thunky npm package is designed to delay a function's execution until it's actually needed. It wraps a function in a way that ensures it is only called once, regardless of how many times the wrapper is invoked. This is particularly useful for initialization functions that you don't want to run multiple times or expensive operations that should be deferred until absolutely necessary.
Lazy initialization
This feature allows for the lazy initialization of resources. The provided code sample demonstrates how a potentially expensive operation (simulated with a setTimeout) is wrapped in a thunky function. Despite calling 'load' twice, the initialization code only runs once, and both calls receive the result once it's available.
const thunky = require('thunky');
let load = thunky((callback) => {
console.log('Initializing...');
setTimeout(() => callback(null, 'Initialization complete'), 1000);
});
load((err, message) => console.log(message));
load((err, message) => console.log(message));The 'once' package ensures a function can only be called once. It's similar to thunky in preventing multiple invocations, but it doesn't support lazy initialization. Instead, it's focused on ensuring a function doesn't execute more than once, regardless of its purpose.
Memoizee is a comprehensive memoization library that caches the results of function calls based on their arguments. While it serves a different primary purpose than thunky, it achieves a similar effect of avoiding repeated expensive operations. However, memoizee is more versatile in caching multiple calls with different arguments, whereas thunky is focused on single or no-argument functions that need to be delayed or ensured to only run once.
Readme
Delay the evaluation of a paramless async function and cache the result (see thunk).
npm install thunky
Let's make a simple function that returns a random number 1 second after it is called for the first time
var thunky = require('thunky')
var test = thunky(function (callback) { // the inner function should only accept a callback
console.log('waiting 1s and returning random number')
setTimeout(function () {
callback(Math.random())
}, 1000)
})
test(function (num) { // inner function is called the first time we call test
console.log(num) // prints random number
})
test(function (num) { // subsequent calls waits for the first call to finish and return the same value
console.log(num) // prints the same random number as above
})
Thunky makes it easy to implement a lazy evaluation pattern.
var getDb = thunky(function (callback) {
db.open(myConnectionString, callback)
})
var queryDb = function (query, callback) {
getDb(function (err, db) {
if (err) return callback(err)
db.query(query, callback)
})
}
queryDb('some query', function (err, result) { ... } )
queryDb('some other query', function (err, result) { ... } )
The first time getDb is called it will try do open a connection to the database.
Any subsequent calls will just wait for the first call to complete and then call your callback.
A nice property of this pattern is that it easily allows us to pass any error caused by getDb to the queryDb callback.
If the thunk callback is called with an Error object as the first argument it will not cache the result
var fails = thunky(function (callback) {
console.log('returning an error')
callback(new Error('bad stuff'))
})
fails(function (err) { // inner function is called
console.log(err)
});
fails(function (err) { // inner function is called again as it returned an error before
console.log(err)
})
A promise version is available as well
var thunkyp = require('thunky/promise')
var ready = thunkyp(async function () {
// ... do async stuff
return 42
})
// same semantics as the callback version
await ready()
MIT
FAQs
delay the evaluation of a paramless async function and cache the result
The npm package thunky receives a total of 8,897,569 weekly downloads. As such, thunky popularity was classified as popular.
We found that thunky demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.