sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 aberto em 29 de jul. de 2020

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (4.304 stars) (150 forks)batch import
bughelp wanted

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

Pilha de tecnologia
typescriptnodejs
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.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Basic TypeScript knowledgeFamiliarity with electron store or conf
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
The issue reports a TypeScript type error when assigning custom deserialize/serialize functions using yaml in electron store v6.0.0. The error indicates that the return type of yaml.safeLoad (string | object | undefined) is not assignable to the expected Deserialize<Record<string, any>>. The fix likely involves updating the type definition in the conf dependency (which electron store uses) to allow undefined in the return type. The relevant files are the type definitions for conf and possibly index.d.ts in electron store. A maintainer should review the Deserialize type and decide whether to widen it or suggest a workaround.