sindresorhus/memoize

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

Open

#90 geöffnet am 1. Feb. 2023

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.155 Stars) (55 Forks)user submission
enhancementhelp wanted

Beschreibung

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
})

Contributor Guide

Tech Stack
javascripttypescriptnodejs
Domain
developer experience
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScriptNode.jsTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.