sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Aberta

#133 aberto em 29 de jul. de 2020

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (150 forks)batch import
bughelp wanted

Métricas do repositório

Stars
 (4.304 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Hi there, we override deserialize to use yaml instead; this previously use to work but a change in the typings of conf now means it doesn't compile in typescript.

serialize: yaml.safeDump,
deserialize: yaml.safeLoad,

Error:

Type '(str: string, opts?: LoadOptions | undefined) => string | object | undefined' is not assignable to type 'Deserialize<Record<string, any>>'.
  Type 'string | object | undefined' is not assignable to type 'Record<string, any>'.
    Type 'undefined' is not assignable to type 'Record<string, any>'.ts(2322)

Guia do colaborador

Direção de pesquisa
O problema relata um erro de tipo TypeScript ao atribuir funções de desserialização/serialização personalizadas usando yaml no electron store v6.0.0. O erro indica que o tipo de retorno de yaml.safeLoad (string | object | undefined) não é atribuível ao Deserialize<Record<string, any>> esperado. A correção provavelmente envolve atualizar a definição de tipo na dependência conf (que o electron store usa) para permitir undefined no tipo de retorno. Os arquivos relevantes são as definições de tipo para conf e possivelmente index.d.ts no electron store. Um mantenedor deve revisar o tipo Deserialize e decidir se o amplia ou sugere uma solução alternativa.
Pilha de tecnologia
typescriptnodejselectron
Domain
desktop
Tipo Issue
Bug
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 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
TypeScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60