sindresorhus/memoize

Warn when `cacheKey` is unset and `function.length > 1`?

Open

#90 ouverte le 1 févr. 2023

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)TypeScript (1 155 stars) (55 forks)user submission
enhancementhelp wanted

Description

By default, only the memoized function's first argument is considered via strict equality comparison

I think mem should call console.warn in this case:

mem(async (host, path) => fetch(host + path))

Correct usage:

mem(async (host, path) => fetch(host + path), {
  cacheKey: args => args.join()
})

mem(async (host, path) => fetch(host + path), {
  cacheKey: JSON.stringify
})

Guide contributeur

Stack technique
javascripttypescriptnodejs
Domaine
developer experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaScriptNode.jsTypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
Examine the main source file (likely index.ts) to locate the memoize function implementation. Add a conditional check: if the memoized function has more than one argument (function.length > 1) and no custom cacheKey option is provided, output a one time warning using console.warn explaining the default behavior and suggesting to provide a cacheKey. Write tests to verify the warning is emitted only when appropriate, and update any relevant documentation.