sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Ouverte

#133 ouverte le 29 juil. 2020

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (150 forks)batch import
bughelp wanted

Métriques du dépôt

Stars
 (4 304 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Direction de recherche
Le problème signale une erreur de type TypeScript lors de l'attribution de fonctions de désérialisation/sérialisation personnalisées utilisant yaml dans electron store v6.0.0. L'erreur indique que le type de retour de yaml.safeLoad (string | object | undefined) n'est pas assignable au Deserialize<Record<string, any>> attendu. La correction implique probablement de mettre à jour la définition de type dans la dépendance conf (utilisée par electron store) pour autoriser undefined dans le type de retour. Les fichiers concernés sont les définitions de type pour conf et éventuellement index.d.ts dans electron store. Un mainteneur doit examiner le type Deserialize et décider de l'élargir ou de suggérer un contournement.
Stack technique
typescriptnodejselectron
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
TypeScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60