sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

開放

#133 建立於 2020年7月29日

在 GitHub 查看貢獻者指南
 (0 則留言) (0 個反應) (0 位負責人)JavaScript (150 個分叉)batch import
bughelp wanted

倉庫指標

星標
 (4,304 顆星)
PR 合併指標
 (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