Vincit/objection.js

Missing typings for QueryBuilder.tableRef

Open

#2364 opened on Mar 16, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (7,146 stars) (663 forks)batch import
good first issuetypings

Description

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
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.
1-3 hours
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.
mostly clear
Prerequisites
TypeScript knowledgefamiliarity with Objection.js typings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.