Vincit/objection.js

Missing typings for QueryBuilder.tableRef

Open

#2,364 opened on Mar 16, 2023

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

Repository metrics

Stars
 (7,146 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the typings file at typings/objection/index.d.ts to add the missing `tableRef` method signature for QueryBuilder.
Tech stack
javascripttypescript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85