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.