sindresorhus/memoize

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

Open

#90 opened on Feb 1, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)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
})

Contributor guide

Tech stack
javascripttypescriptnodejs
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.
Warn when `cacheKey` is unset and `function.length > 1`? · sindresorhus/memoize#90 | Good First Issue