Vincit/objection.js

Missing typings for QueryBuilder.tableRef

Open

#2,364 创建于 2023年3月16日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)JavaScript (7,146 star) (663 fork)batch import
good first issuetypings

描述

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.

贡献者指南

技术栈
javascripttypescriptnodejssql
领域
backendapidatabase
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
TypeScript knowledgefamiliarity with Objection.js typings
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
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.