Interface SortParams<T>

interface SortParams<T> {
    columnName: string;
    direction: SortOrder;
    fieldName: T;
}

Type Parameters

  • T

Properties

columnName direction fieldName

Properties

columnName

columnName: string

Database column name. Camel cased fieldName.

Example

const orderBy = 'createdAt_ASC';
const sort = extractSortParams(orderBy); // sort.columnName = 'created_at';
query.orderBy(`v.${sort.columnName}`, sort.direction);

direction

direction: SortOrder

Sort direction (or order) (ASC | DESC)

Example

const orderBy = 'createdAt_ASC';
const sort = extractSortParams(orderBy); // sort.direction = 'ASC';
query.orderBy(`v.${sort.columnName}`, sort.direction);

fieldName

fieldName: T

Original sort field name.

Example

const orderBy = 'createdAt_ASC';
const sort = extractSortParams(orderBy); // sort.fieldName = 'uploaderName';
if (sort.fieldName === uploaderName) {
 ...
}

Settings

Member Visibility

On This Page

Properties