porsager/postgres

Incorrect constructor parameter types for class `PostgresError`

Open

#703 建立於 2023年10月19日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (6,221 star) (230 fork)batch import
Typescripthelp wanted

描述

According to the types, to construct a new PostgresError the first argument is a message string:

With this code:

import postgres from "postgres";

const error = new postgres.PostgresError("Error message.");

console.log(Object.entries(error));

What actually logs is:

[
  [ '0', 'E' ],
  [ '1', 'r' ],
  [ '2', 'r' ],
  [ '3', 'o' ],
  [ '4', 'r' ],
  [ '5', ' ' ],
  [ '6', 'm' ],
  [ '7', 'e' ],
  [ '8', 's' ],
  [ '9', 's' ],
  [ '10', 'a' ],
  [ '11', 'g' ],
  [ '12', 'e' ],
  [ '13', '.' ],
  [ 'name', 'PostgresError' ]
]

That's because actually the first argument it seems is supposed to be an Error instance:

https://github.com/porsager/postgres/blob/0428b30937400a7dadc8ed09587c44ef917052a6/src/errors.js#L1-L7

貢獻者指南

技術棧
javascriptnodejspostgresqltypescript
領域
backenddatabase
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic JavaScriptUnderstanding of Postgres.js error handling
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
The issue is in the constructor of PostgresError class in src/errors.js (lines 1-7). Currently, the constructor expects an Error instance as the first argument, but the TypeScript types indicate it should accept a string. The fix likely involves either adjusting the constructor to accept a string and create an Error internally, or updating the type definitions to match the actual implementation. Check the existing tests for PostgresError to ensure the change is consistent.