sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 opened on Jul 29, 2020

View on 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)

Contributor guide

Tech stack
typescriptnodejs
Domain
desktop
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic TypeScript knowledgeFamiliarity with electron store or conf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.