sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 创建于 2020年7月29日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (150 fork)batch import
bughelp wanted

仓库指标

Star
 (4,304 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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)

贡献者指南

研究方向
该问题报告了在 electron store v6.0.0 中使用 yaml 分配自定义反序列化/序列化函数时出现的 TypeScript 类型错误。错误提示 yaml.safeLoad 的返回类型（string | object | undefined）无法分配给预期的 Deserialize<Record<string, any>>。修复可能涉及更新 electron store 所使用的 conf 依赖中的类型定义，以允许返回类型中包含 undefined。相关文件是 conf 的类型定义，可能还包括 electron store 中的 index.d.ts。维护者应审查 Deserialize 类型，并决定是放宽其限制还是建议一种变通方案。
技术栈
typescriptnodejselectron
领域
desktop
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
TypeScriptGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60