pqb 0.18.33 → 0.18.34

package/dist/index.mjs

@@ -6183,7 +6183,7 @@ class QueryGet {
    * It will throw `NotFoundError` when not found.
    *
    * ```ts
-   * import { NumberColumn } from 'pqb';
+   * import { NumberColumn } from 'orchid-orm';
    *
    * const firstName: string = await db.table.get('name');
    *
@@ -7467,7 +7467,7 @@ class JsonModifiers extends QueryBase {
    * Selects a value from JSON data using a JSON path.
    *
    * ```ts
-   * import { columnTypes } from 'pqb';
+   * import { columnTypes } from 'orchid-orm';
    *
    * db.table.jsonPathQuery(
    *   columnTypes.text(3, 100), // type of the value
@@ -8054,7 +8054,7 @@ class With {
    * Add Common Table Expression (CTE) to the query.
    *
    * ```ts
-   * import { columnTypes } from 'pqb';
+   * import { columnTypes } from 'orchid-orm';
    * import { NumberColumn } from './number';
    *
    * // .with optionally accepts such options:
@@ -8559,7 +8559,7 @@ class Update {
    * To make sure that at least one row was updated use `updateOrThrow`:
    *
    * ```ts
-   * import { NotFoundError } from 'pqb';
+   * import { NotFoundError } from 'orchid-orm';
    *
    * try {
    *   // updatedCount is guaranteed to be greater than 0
@@ -9895,6 +9895,20 @@ class QueryMethods {
    * await selectFollowing(db.user.select('id', 'name'), currentUser);
    * ```
    *
+   * To get the result type of query helper, use `QueryHelperResult` type:
+   *
+   * ```ts
+   * import { QueryHelperResult } from 'orchid-orm';
+   *
+   * const selectHelper = db.table.makeHelper((q) => q.select('id', 'name'));
+   *
+   * // This type is identical to `db.table.select('id', 'name')`
+   * type SelectQuery = QueryHelperResult<typeof selectHelper>;
+   *
+   * // Await to get result, the type is `{ id: number, name: string }[]`
+   * type Result = Awaited<QueryHelperResult<typeof selectHelper>>;
+   * ```
+   *
    * @param fn - helper function
    */
   makeHelper(fn) {