porsager/postgres

The type passed into the generic shouldn't have to be specified as an array

Open

#647 opened on Jul 20, 2023

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

Description

Currently using the library you would pass your type as such

type User = {
  email: string
  password: string
}

const [user] = await sql<U͟s͟e͟r[]>`
  SELECT * FROM example;
`;

console.log(user.email);

Though its not a huge deal I feel as code quality would be better with simply omitting it

type User = {
  email: string
  password: string
}

const [user] = await sql<U͟s͟e͟r>`
  SELECT * FROM example;
`;

console.log(user.email);

You can even see an example of this on the typescript documentation

Contributor guide

Tech stack
typescriptpostgresql
Domain
backenddeveloper experience
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript genericspostgres.js type definitions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Locate the type definition for the `sql` template literal function, likely in `src/index.ts` or a `.d.ts` file. The current signature accepts `User[]` as a generic parameter; modify it to accept `User` directly while still returning an array. Ensure the change is backward compatible by may require wrapping the type in an array internally. No linked PRs or maintainer comments exist, so propose the change and open a PR with tests.