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 (55 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (1,155 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Add a console.warn in the memoize function when the cached function accepts more than one argument and no cacheKey option is provided. The warning should suggest using a custom cacheKey.
Tech stack
typescriptjavascript
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80