Vincit/objection.js

Missing typings for QueryBuilder.tableRef

Open

#2,364 opened on 2023年3月16日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)JavaScript (7,146 stars) (663 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Missing typings for QueryBuilder.tableRef · Vincit/objection.js#2364 | Good First Issue