Defining columns

The available column types can be imported with:

import { columns } from "ts-query-model";

See the menu on the left for details on the available column types.

The column types perform these functions:

• transforming data from JavaScript types to SQL types
• transforming data from SQL types to JavaScript types
• providing type information for the TypeScript compiler

Implementation

A single column definition has the following interface:

interface ColumnDefinition {
  toSQL: (valueFromJS: any) => any;
  fromSQL: (valueFromSQL: any) => any;
}

where:

• toSQL takes the JavaScript type and returns the SQL type
• fromSQL takes the SQL type and returns the JavaScript type

Example

To implementation of the numberColumn looks something like this:

const numberColumn = () => ({
  toSQL: (valueFromJS: number) => valueFromJS,
  fromSQL: (valueFromSQL: number) => valueFromSQL,
});

Create your own types

You can use any types and transformations you wish as columns. Just create an object with both the toSQL and fromSQL functions following the ColumnDefinition above.