porsager/postgres

Incorrect constructor parameter types for class `PostgresError`

Open

#703 opened on Oct 19, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (6,221 stars) (230 forks)batch import
Typescripthelp wanted

Description

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

Contributor guide

Tech stack
javascriptnodejspostgresqltypescript
Domain
backenddatabase
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptUnderstanding of Postgres.js error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.