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 (150 forks)batch import
bughelp wanted

Repository metrics

Stars
 (4,304 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Inspect the type definition of Deserialize in electron store and the return type of yaml.safeLoad. Ensure the return type matches Record<string, any>. Consider updating the type to accept broader return types or cast the deserialize function.
Tech stack
typescriptnodejselectron
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.
1-3 hours
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60