BlaanTeam / ts-sql-builder

SQL query & schema generator for Node.js

Home Page:https://www.npmjs.com/package/ts-sql-builder

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add documentation

os-moussao opened this issue · comments

Issue Type

Docs

Description

  • Add README.md
  • Add JSDoc comments
  • Generate documentation (may use typedoc for that)

Example

  /**
   * Add columns to the SELECT clause of the SQL query.
   * @param selection A column name, a record of columns-aliases, or an array containing a mix both.
   * @param fromTable Optional. If specified, all selected columns are prefixed with 'fromTable.'.
   * @returns The current instance of the QueryBuilder for method chaining.
   */
  select(...)