Vincit/objection.js

Missing typings for QueryBuilder.tableRef

Open

#2.364 geöffnet am 16. März 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (7.146 Stars) (663 Forks)batch import
good first issuetypings

Beschreibung

QueryBuilder has a convenient method tableRef which returns the alias for the model the query builder operates against:

https://github.com/Vincit/objection.js/blob/1b74f756c8afd3bab7964ac3aea7438b95edce44/lib/queryBuilder/QueryBuilder.js#L87-L89

However it's not exposed in typings and not mentioned in the documentation. Can we add it?

On a side note, its implementation clearly contradicts the typings for tableRefFor:

https://github.com/Vincit/objection.js/blob/1b74f756c8afd3bab7964ac3aea7438b95edce44/typings/objection/index.d.ts#L615-L617

the method is supposed to accept a model class, but the actual implementation passes a string.

Contributor Guide

Tech Stack
javascripttypescriptnodejssql
Domain
backendapidatabase
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
TypeScript knowledgefamiliarity with Objection.js typings
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
Examine the typings file at typings/objection/index.d.ts. Locate the existing `tableRefFor` declaration and the missing `tableRef` declaration. Add a new method signature for `tableRef()` that returns a string, consistent with the implementation in lib/queryBuilder/QueryBuilder.js. Additionally, fix the `tableRefFor` typing to accept a ModelClass as per the implementation. Verify by running TypeScript type checking.