Skip to content

Add documentation #7

@os-moussao

Description

@os-moussao

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(...)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions