sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 建立於 2020年7月29日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (4,304 star) (150 fork)batch import
bughelp wanted

描述

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)

貢獻者指南

技術棧
typescriptnodejs
領域
desktop
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic TypeScript knowledgeFamiliarity with electron store or conf
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.