Skip to content

TColumn.sort Has Wrong Definition #1510

@dday9

Description

@dday9

The documentation states that a TColumn's sort property's type can either be a Boolean or a SortConfig: https://gridjs.io/docs/config/sort#generic-sort-config

However, the TColumn interface defines the sort property as a nullable SortConfig: https://github.com/grid-js/gridjs/blob/master/src/types.ts#L34

The code behaves like the documentation, so the interface should be updated to reflect the documentation:

export interface TColumn {
  // ...
  sort?: boolean | SortConfig;
  // ...
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions