sindresorhus/electron-store

Types error with setting deserialize in v6.0.0

Open

#133 opened on 2020年7月29日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)JavaScript (4,304 stars) (150 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.