sindresorhus/memoize

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

Open

#90 aberto em 1 de fev. de 2023

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

Guia do colaborador

Pilha de tecnologia
javascripttypescriptnodejs
Domain
developer experience
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
JavaScriptNode.jsTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
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.