sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 ouverte le 29 juil. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)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)

Guide contributeur

Stack technique
typescriptnodejs
Domaine
desktop
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Basic TypeScript knowledgeFamiliarity with electron store or conf
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.